oapi

type BadRequest = Error

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

type ClientInterface interface {
	// CreateEmailMessageBatchWithBody request with any body
	CreateEmailMessageBatchWithBody(ctx context.Context, params *CreateEmailMessageBatchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateEmailMessageBatch(ctx context.Context, params *CreateEmailMessageBatchParams, body CreateEmailMessageBatchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListEmailMessages request
	ListEmailMessages(ctx context.Context, params *ListEmailMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateEmailMessageWithBody request with any body
	CreateEmailMessageWithBody(ctx context.Context, params *CreateEmailMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateEmailMessage(ctx context.Context, params *CreateEmailMessageParams, body CreateEmailMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEmailMessage request
	GetEmailMessage(ctx context.Context, messageId EmailID, reqEditors ...RequestEditorFn) (*http.Response, error)
}

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// CreateEmailMessageBatchWithBodyWithResponse request with any body
	CreateEmailMessageBatchWithBodyWithResponse(ctx context.Context, params *CreateEmailMessageBatchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEmailMessageBatchResponse, error)

	CreateEmailMessageBatchWithResponse(ctx context.Context, params *CreateEmailMessageBatchParams, body CreateEmailMessageBatchJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEmailMessageBatchResponse, error)

	// ListEmailMessagesWithResponse request
	ListEmailMessagesWithResponse(ctx context.Context, params *ListEmailMessagesParams, reqEditors ...RequestEditorFn) (*ListEmailMessagesResponse, error)

	// CreateEmailMessageWithBodyWithResponse request with any body
	CreateEmailMessageWithBodyWithResponse(ctx context.Context, params *CreateEmailMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEmailMessageResponse, error)

	CreateEmailMessageWithResponse(ctx context.Context, params *CreateEmailMessageParams, body CreateEmailMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEmailMessageResponse, error)

	// GetEmailMessageWithResponse request
	GetEmailMessageWithResponse(ctx context.Context, messageId EmailID, reqEditors ...RequestEditorFn) (*GetEmailMessageResponse, error)
}

type CreateEmailMessageBatchJSONRequestBody = EmailMessageBatchRequest

type CreateEmailMessageBatchParams struct {
	// IdempotencyKey Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
	// Two distinct 409 errors signal misuse:
	// - `request_in_progress` (E01004) — the same key is currently being
	//   processed by a concurrent request. Wait briefly and retry; the lock
	//   expires within 30 seconds.
	// - `idempotency_key_reuse` (E01005) — the same key has already completed
	//   against a different request body or method. Generate a new key.
	//
	// Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

type CreateEmailMessageBatchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *EmailMessageBatchResponse
	JSON400      *BadRequest
	JSON401      *Unauthorized
	JSON402      *PaymentRequired
	JSON403      *Forbidden
	JSON413      *PayloadTooLarge
	JSON422      *Unprocessable
	JSON429      *RateLimited
	JSON500      *InternalError
}

type CreateEmailMessageJSONRequestBody = EmailMessageSendRequest

type CreateEmailMessageParams struct {
	// IdempotencyKey Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
	// Two distinct 409 errors signal misuse:
	// - `request_in_progress` (E01004) — the same key is currently being
	//   processed by a concurrent request. Wait briefly and retry; the lock
	//   expires within 30 seconds.
	// - `idempotency_key_reuse` (E01005) — the same key has already completed
	//   against a different request body or method. Generate a new key.
	//
	// Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

type CreateEmailMessageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *EmailMessage
	JSON400      *BadRequest
	JSON401      *Unauthorized
	JSON402      *PaymentRequired
	JSON403      *Forbidden
	JSON413      *PayloadTooLarge
	JSON422      *Unprocessable
	JSON429      *RateLimited
	JSON500      *InternalError
}

type CreatedAfter = time.Time

type CreatedBefore = time.Time

type DocsSearchResponse struct {
	// Locale The documentation locale the results were drawn from.
	Locale *string `json:"locale,omitempty"`

	// Query The search query that produced these results.
	Query *string `json:"query,omitempty"`

	// Results Matching documentation sections, ordered by descending relevance.
	Results *[]DocsSearchResult `json:"results,omitempty"`
}

type DocsSearchResult struct {
	// DocUrl Relative path to the page, without the section anchor. Results from the same page share it, so it can be used to group them.
	DocUrl *string `json:"doc_url,omitempty"`

	// Highlights The passages of the section that match the query, longer than the snippet. Returned only when contents is highlights.
	Highlights *[]string `json:"highlights,omitempty"`

	// MarkdownUrl Absolute URL that returns the page's full content as Markdown. Fetch it to read the whole page.
	MarkdownUrl *string `json:"markdown_url,omitempty"`

	// Score Relevance score. Higher is more relevant; results are ordered by descending score.
	Score *float32 `json:"score,omitempty"`

	// Section Heading of the matching section within the page.
	Section *string `json:"section,omitempty"`

	// Snippet Short excerpt of the matching content, with the query terms in context. Always returned.
	Snippet *string `json:"snippet,omitempty"`

	// Title Title of the documentation page this result belongs to.
	Title *string `json:"title,omitempty"`

	// TokenEstimate Approximate token count of the full page returned by markdown_url, to budget reading it. Results from the same page share it.
	TokenEstimate *int `json:"token_estimate,omitempty"`

	// Url Relative path to the matching section, including the heading anchor.
	Url *string `json:"url,omitempty"`
}

type EmailAddress struct {
	// Email Email address.
	Email openapi_types.Email `json:"email"`

	// Name Display name shown alongside the address in mail clients.
	Name *string `json:"name,omitempty"`
}

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

type EmailAddressInput0 = string

type EmailAttachment struct {
	// Content Base64-encoded attachment bytes. Required. Counts toward the 20 MB estimated generated message-size cap after encoding and MIME wrapping.
	Content []byte `json:"content"`

	// ContentId RFC 2392 Content-ID. When set, the attachment is rendered inline and can be referenced from the HTML body as `<img src="cid:{content_id}"/>`. When omitted, the attachment is rendered as a regular file attachment.
	ContentId *string `json:"content_id,omitempty"`

	// ContentType MIME type. Inferred from `filename` extension when omitted. Used to enforce the blocklist of disallowed executable / script types.
	ContentType *string `json:"content_type,omitempty"`

	// Filename Filename shown to the recipient. Required.
	Filename string `json:"filename"`

	// Path Preview feature — provide a URL and Bird fetches the attachment for you. Currently unavailable. Use `content` instead. The schema currently requires `content`, so a request with only `path` is rejected with 422 for missing `content`; a request supplying both `content` and `path` is rejected with 422 `unsupported_feature` until this preview ships. When generally available: HTTPS-only, single redirect followed and re-validated, private IP ranges blocked, request timeout enforced, fetched content counts toward the 20 MB estimated generated message-size cap after encoding and MIME wrapping.
	Path *string `json:"path,omitempty"`
}

type EmailAttachmentID = string

type EmailAttachmentRef struct {
	// ContentId The Content-ID set at send time, when the attachment was inline.
	ContentId *string `json:"content_id,omitempty"`

	// ContentType Resolved MIME type at send time.
	ContentType *string `json:"content_type,omitempty"`

	// Filename Filename as shown to the recipient.
	Filename string             `json:"filename"`
	Id       *EmailAttachmentID `json:"id,omitempty"`

	// Inline True when the attachment was sent inline via a `content_id` reference in the HTML body, false for regular file attachments.
	Inline *bool `json:"inline,omitempty"`

	// Size Decoded size in bytes.
	Size int `json:"size"`
}

type EmailBounceType string

type EmailEvent struct {
	// BounceClass Numeric bounce classification for fine-grained deliverability triage. Lets you distinguish, for example, a DNS failure from a spam block when both would be `bounce_type: soft` or `bounce_type: block`. Present on `email.bounced`, `email.out_of_band_bounce`, and `email.deferred`.
	BounceClass *int `json:"bounce_class,omitempty"`

	// BounceCode SMTP status code returned by the receiving mail server. Present on `email.bounced` and `email.deferred` events.
	BounceCode *string `json:"bounce_code,omitempty"`

	// BounceDescription Human-readable bounce reason. Present on `email.bounced` and `email.deferred` events.
	BounceDescription *string `json:"bounce_description,omitempty"`

	// BounceType Bounce classification. Present on `email.bounced`, `email.out_of_band_bounce`, and `email.deferred` events. `hard` is a permanent failure (invalid address or non-existent domain). `soft` is a transient failure (mailbox full, server temporarily unavailable). `block` indicates the receiving mail server blocked the sending IP for reputation reasons. `admin` indicates an administrative refusal (relaying denied, blocklisted domain). `undetermined` is used when the receiving server's response is ambiguous.
	BounceType *EmailEventBounceType `json:"bounce_type,omitempty"`

	// Country ISO 3166-1 alpha-2 country code derived from the client IP. Present on `email.opened` and `email.clicked` events when available.
	Country *string `json:"country,omitempty"`

	// Id Event ID.
	Id *string `json:"id,omitempty"`

	// IpAddress Client IP address (IPv4 or IPv6). Present on `email.opened` and `email.clicked` events when available.
	IpAddress *string `json:"ip_address,omitempty"`

	// IsPrefetched True when the open was auto-fetched by an inbox privacy feature (Apple Mail Privacy Protection, Gmail image proxy) rather than a real user action. Useful for accurate open-rate calculation. Present on `email.opened` only.
	IsPrefetched *bool `json:"is_prefetched,omitempty"`

	// OccurredAt When this event occurred.
	OccurredAt  time.Time   `json:"occurred_at"`
	RecipientId RecipientID `json:"recipient_id"`

	// RejectionReason Specific cause of rejection. Present on `email.rejected` events only. See `EmailRecipient.rejection_reason` for the meaning of each value.
	RejectionReason *EmailEventRejectionReason `json:"rejection_reason,omitempty"`

	// SendingIp The IP address Bird used to send this message. Useful when investigating deliverability issues that correlate with specific IPs. Present on `email.delivered`, `email.bounced`, `email.out_of_band_bounce`, and `email.deferred` events.
	SendingIp *string `json:"sending_ip,omitempty"`

	// Type Type of an event in a message's per-recipient delivery timeline. Open enum — new event types may be added over time, so treat any unrecognized value as a future event rather than an error. The values below are the types known at this version.
	Type EmailEventType `json:"type"`

	// Url The clicked URL. Present on `email.clicked` events.
	Url *string `json:"url,omitempty"`

	// UserAgent Client user-agent string. Present on `email.opened` and `email.clicked` events when available.
	UserAgent *string `json:"user_agent,omitempty"`
}

type EmailEventBounceType string

type EmailEventList struct {
	// Data Page of timeline events for this email send, in chronological order.
	Data []EmailEvent `json:"data"`

	// NextCursor Cursor for the next page. Pass back as `starting_after` to advance forward. Null when no next page exists.
	NextCursor *string `json:"next_cursor"`

	// PrevCursor Cursor for the previous page. Pass back as `ending_before` to step backward. Null when no previous page exists.
	PrevCursor *string `json:"prev_cursor"`

	// RefreshCursor Refresh anchor. Pass back as `ending_before` later to fetch items that have appeared since this response. Non-null whenever `data` is non-empty; null only on an empty page. Distinct from `prev_cursor`.
	RefreshCursor *string `json:"refresh_cursor"`
}

type EmailEventRejectionReason string

type EmailEventType = string

type EmailID = string

type EmailMessage struct {
	// AcceptedCount Number of recipients currently in the `accepted` state — Bird has the send and is preparing to deliver.
	AcceptedCount *int `json:"accepted_count,omitempty"`

	// Attachments Attachment metadata for the send. Empty when no attachments were included. Raw content is not echoed; use the future content-retrieval endpoint when storage is enabled.
	Attachments *[]EmailAttachmentRef `json:"attachments,omitempty"`

	// Bcc BCC recipients.
	Bcc *[]EmailAddress `json:"bcc,omitempty"`

	// BouncedCount Number of recipients that resulted in a permanent delivery failure.
	BouncedCount *int `json:"bounced_count,omitempty"`

	// Category Content classification. Controls suppression policy — `marketing` blocks on all suppression reasons; `transactional` allows delivery through complaint and unsubscribe suppressions.
	Category EmailMessageCategory `json:"category"`

	// Cc CC recipients.
	Cc *[]EmailAddress `json:"cc,omitempty"`

	// ClickCount Total click events across all recipients.
	ClickCount *int `json:"click_count,omitempty"`

	// ComplainedCount Number of recipients that reported spam.
	ComplainedCount *int `json:"complained_count,omitempty"`

	// CreatedAt When the send request was accepted.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// DeferredCount Number of recipients in transient delivery deferral; the provider is retrying.
	DeferredCount *int `json:"deferred_count,omitempty"`

	// DeliveredAt When all recipients reached a terminal delivered state, or null if not yet fully delivered.
	DeliveredAt *time.Time `json:"delivered_at,omitempty"`

	// DeliveredCount Number of recipients whose messages were accepted by the remote MTA.
	DeliveredCount *int `json:"delivered_count,omitempty"`

	// DeliveryLatencyMs Time between the message being processed and the receiving mail server accepting it, in milliseconds, for the fastest delivered recipient. Null until the first recipient is delivered.
	DeliveryLatencyMs *int `json:"delivery_latency_ms,omitempty"`

	// From An email address with an optional display name.
	From EmailAddress `json:"from"`
	Id   EmailID      `json:"id"`

	// InReplyToMessageId The message this one is a reply to, if any.
	InReplyToMessageId *EmailID `json:"in_reply_to_message_id,omitempty"`

	// Metadata Arbitrary JSON metadata stored on the message object and echoed in webhook payloads. See EmailMessageSendRequest for the tags vs metadata distinction.
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// OpenCount Total open events across all recipients.
	OpenCount *int `json:"open_count,omitempty"`

	// ProcessedCount Number of recipients for whom Bird has processed the message and queued it for delivery.
	ProcessedCount *int `json:"processed_count,omitempty"`

	// ProcessingLatencyMs Time between Bird accepting the send and the message being processed for delivery, in milliseconds, for the fastest recipient. Null until the first recipient reaches `processed`.
	ProcessingLatencyMs *int `json:"processing_latency_ms,omitempty"`

	// RejectedCount Number of recipients rejected before delivery. See the per-recipient `rejection_reason` field on `GET /v1/email/messages/{message_id}/recipients` for the specific cause (suppression match, transmission failure, generation failure, or policy refusal).
	RejectedCount *int `json:"rejected_count,omitempty"`

	// ReplyTo Reply-To addresses, if set on the send. Empty/null when no Reply-To was provided.
	ReplyTo *[]EmailAddress `json:"reply_to,omitempty"`

	// ScheduledAt When this message is scheduled to send, for a send created with a future send time. Null for an immediate send. Stays set after the scheduled send fires.
	ScheduledAt *time.Time `json:"scheduled_at,omitempty"`

	// Status Aggregate delivery status derived from recipient states. `scheduled` means the message is queued to send at a future time and has not been dispatched yet. `accepted` means Bird has the send and is preparing to deliver. `processed` means Bird has processed the message and queued it for delivery to the recipient's mail server. `canceled` means a scheduled message was canceled before it was sent.
	Status *EmailMessageStatus `json:"status,omitempty"`

	// Subject Message subject line.
	Subject string `json:"subject"`

	// Tags Structured `{name, value}` filter labels applied to this send. See EmailMessageSendRequest for the tags vs metadata distinction.
	Tags *[]EmailTag `json:"tags,omitempty"`

	// ThreadId Thread this message belongs to. Null until threading is enabled.
	ThreadId *string `json:"thread_id,omitempty"`

	// To Primary recipients. Length is the recipient count; use the broadcasts endpoint for audience-targeted sends. Each entry's `name` is present when a display name was provided on the send.
	To []EmailAddress `json:"to"`

	// TotalLatencyMs End-to-end accept → delivered time for the fastest delivered recipient, in milliseconds. Null until the first recipient is delivered.
	TotalLatencyMs *int `json:"total_latency_ms,omitempty"`

	// TrackClicks Whether click tracking is enabled for this send.
	TrackClicks bool `json:"track_clicks"`

	// TrackOpens Whether open tracking is enabled for this send.
	TrackOpens bool `json:"track_opens"`
}

type EmailMessageBatchItem struct {
	// Category Resolved category for this batch item.
	Category EmailMessageBatchItemCategory `json:"category"`
	Id       EmailID                       `json:"id"`

	// Status Initial status of this message in the batch.
	Status *EmailMessageBatchItemStatus `json:"status,omitempty"`
}

type EmailMessageBatchItemCategory string

type EmailMessageBatchItemStatus string

type EmailMessageBatchRequest = []EmailMessageSendRequest

type EmailMessageBatchResponse struct {
	// Data One entry per message in the batch, in submission order.
	Data []EmailMessageBatchItem `json:"data"`
}

type EmailMessageCategory string

type EmailMessageContent struct {
	// Html The HTML body of the message, if it was stored.
	Html *string `json:"html,omitempty"`

	// Text The plain-text body of the message, if it was stored.
	Text *string `json:"text,omitempty"`
}

type EmailMessageList struct {
	// Data Page of message objects.
	Data []EmailMessage `json:"data"`

	// NextCursor Cursor for the next page. Pass back as `starting_after` to advance forward. Null when no next page exists.
	NextCursor *string `json:"next_cursor"`

	// PrevCursor Cursor for the previous page. Pass back as `ending_before` to step backward. Null when no previous page exists.
	PrevCursor *string `json:"prev_cursor"`

	// RefreshCursor Refresh anchor. Pass back as `ending_before` later to fetch items that have appeared since this response. Non-null whenever `data` is non-empty; null only on an empty page. Distinct from `prev_cursor`.
	RefreshCursor *string `json:"refresh_cursor"`
}

type EmailMessageSendRequest struct {
	// Attachments File attachments. Bird rejects sends whose estimated generated message size exceeds 20 MB. The estimate is the HTML and text body plus all attachments and inline images measured after base64 encoding. Keep total raw attachment content at or below 15 MB for reliable headroom. In batch sends, this per-message cap still applies and the serialized JSON request body for the whole batch has a hard 20 MB cap. See the EmailAttachment schema for the full field contract.
	Attachments *[]EmailAttachment `json:"attachments,omitempty"`

	// Bcc BCC recipients. Each entry is a plain email string, an RFC 5322 mailbox string (`Jane <jane@example.com>`), or an object with an optional display name.
	Bcc *[]EmailAddressInput `json:"bcc,omitempty"`

	// Category Content classification — independent of which endpoint you use. Controls suppression policy: `marketing` blocks on all suppression reasons (use for marketing content); `transactional` allows delivery through complaint and unsubscribe suppressions (use for receipts, password resets, and similar operational messages). Default: transactional.
	Category *EmailMessageSendRequestCategory `json:"category,omitempty"`

	// Cc CC recipients. Each entry is a plain email string, an RFC 5322 mailbox string (`Jane <jane@example.com>`), or an object with an optional display name.
	Cc *[]EmailAddressInput `json:"cc,omitempty"`

	// ContactId Preview feature — contact-targeted sends. Currently unavailable; supplying this field returns `422 unsupported_feature`.
	ContactId *string `json:"contact_id,omitempty"`

	// From A sender or recipient address. Accepts a plain email string (`jane@example.com`), an RFC 5322 mailbox string with an embedded display name (`Jane Doe <jane@example.com>`), or an object carrying the address and an optional display name. All forms can be mixed freely within one request; responses always return the object form.
	From EmailAddressInput `json:"from"`

	// Headers Custom email headers as key-value pairs.
	Headers *map[string]string `json:"headers,omitempty"`

	// Html HTML body. At least one of html or text must be provided.
	Html               *string  `json:"html,omitempty"`
	InReplyToMessageId *EmailID `json:"in_reply_to_message_id,omitempty"`

	// IpPoolId ID of the IP pool to send from (`ipp_` prefix), or `ipp_shared` to route through the shared pool explicitly. Omit to use your organization's default pool. An unknown pool, or a pool with no dedicated IPs available to send from, is rejected with a `422`.
	IpPoolId *string `json:"ip_pool_id,omitempty"`

	// Metadata Arbitrary JSON object **stored, returned on API reads, and echoed in webhook payloads**. Path-queryable in analytics (e.g. filter on `metadata.order_id`) but not surfaced as a first-class dashboard filter dimension. Cap: 2 KB serialized. Use metadata for per-send context like internal IDs, foreign keys, and structured payloads you want round-tripped through events. For low-cardinality filterable labels, use `tags` instead.
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// ReplyTo Reply-To addresses, each a plain email string, an RFC 5322 mailbox string, or an object with an optional display name. RFC 5322 allows multiple. Every recipient reply hits all listed addresses, so 1-2 is typical; the 25 cap exists to prevent runaway header sizes that some MTAs reject.
	ReplyTo *[]EmailAddressInput `json:"reply_to,omitempty"`

	// ScheduledAt Preview feature — send-later scheduling. Currently unavailable; supplying this field returns `422 unsupported_feature`.
	ScheduledAt *time.Time `json:"scheduled_at,omitempty"`

	// Subject Message subject line.
	Subject string `json:"subject"`

	// Tags Structured `{name, value}` labels for **filtering and analytics**. Tags become first-class query dimensions: filter the list endpoint by tag name, slice analytics rollups by tag, and surface in webhook payloads. Cap: 20 tags per send. Use tags for low-cardinality dimensions (`category`, `experiment_variant`, `template_id`). For arbitrary structured context that you do not need as a filter dimension, use `metadata` instead.
	Tags *[]EmailTag `json:"tags,omitempty"`

	// Text Plain-text body. At least one of html or text must be provided.
	Text *string `json:"text,omitempty"`

	// To Primary recipients. Each entry is a plain email string, an RFC 5322 mailbox string (`Jane <jane@example.com>`), or an object with an optional display name.
	To []EmailAddressInput `json:"to"`

	// TopicId Preview feature — topic-gated sends. Currently unavailable; supplying this field returns `422 unsupported_feature`. When generally available, a non-empty `topic_id` gates delivery on the recipient's opt-in state for that topic — if the recipient is opt_out, the send is silently suppressed and an `email.suppressed` event fires with `reason: topic_opt_out`.
	TopicId *string `json:"topic_id,omitempty"`

	// TrackClicks Whether to track click events for this message.
	TrackClicks *bool `json:"track_clicks,omitempty"`

	// TrackOpens Whether to track open events for this message.
	TrackOpens *bool `json:"track_opens,omitempty"`
}

type EmailMessageSendRequestCategory string

type EmailMessageStatus string

type EmailRecipient struct {
	// BounceCode SMTP reply code returned by the receiving mail server for `bounced` and `deferred` rows, or null when none was provided.
	BounceCode *string `json:"bounce_code,omitempty"`

	// BounceDescription Human-readable reason the receiving mail server gave for the bounce or deferral, or null when none was provided.
	BounceDescription *string `json:"bounce_description,omitempty"`

	// BounceType Bounce classification for `bounced` and `deferred` rows, or null when the recipient has not bounced or the receiving server's response has not been classified. `hard` is a permanent failure (invalid address or non-existent domain). `soft` is a transient failure (mailbox full, server temporarily unavailable). `block` indicates the receiving mail server blocked the sending IP for reputation reasons. `admin` indicates an administrative refusal (relaying denied, blocklisted domain). `undetermined` is used when the receiving server's response is ambiguous.
	BounceType *EmailRecipientBounceType `json:"bounce_type,omitempty"`

	// ClickCount Number of click events for this recipient.
	ClickCount *int `json:"click_count,omitempty"`

	// DeliveredAt When the recipient's mail server accepted the message, or null if not yet delivered.
	DeliveredAt *time.Time `json:"delivered_at,omitempty"`

	// DeliveryLatencyMs Time between Bird processing the message and the receiving mail server accepting it, in milliseconds. Null until delivered.
	DeliveryLatencyMs *int        `json:"delivery_latency_ms,omitempty"`
	Id                RecipientID `json:"id"`

	// Name Display name provided for this recipient on the send, or null if none was given.
	Name *string `json:"name,omitempty"`

	// OpenCount Number of open events for this recipient.
	OpenCount *int `json:"open_count,omitempty"`

	// ParentId ID of the parent message (em_ prefix) or broadcast (eb_ prefix) this recipient belongs to.
	ParentId string `json:"parent_id"`

	// ProcessedAt When Bird processed the message and queued it for delivery to the recipient's mail server, or null if not yet processed.
	ProcessedAt *time.Time `json:"processed_at,omitempty"`

	// ProcessingLatencyMs Time between Bird accepting the send and processing the message for delivery, in milliseconds. Null until processed.
	ProcessingLatencyMs *int `json:"processing_latency_ms,omitempty"`

	// Recipient Recipient email address.
	Recipient openapi_types.Email `json:"recipient"`

	// RejectionReason Present on `status: rejected` rows. Specifies why the recipient was rejected:
	// - `recipient_suppressed`: the recipient is on the workspace suppression list. Bird
	//   did not attempt delivery.
	// - `transmission_failed`: the message could not be transmitted for delivery. - `generation_failure`: the message could not be built for delivery (template or
	//   content issue).
	// - `policy_rejection`: the message was refused by sending policy. - `domain_unverified`: the sending domain was not verified. - `quota_exceeded`: the organization's send quota was reached. - `recipient_not_allowed`: a recipient was not permitted for this send (for shared
	//   onboarding-domain sends, recipients must be verified workspace members).
	RejectionReason *EmailRecipientRejectionReason `json:"rejection_reason,omitempty"`

	// Role Envelope position of a recipient on an outbound email event.
	Role RecipientRole `json:"role"`

	// Status Delivery status for this recipient. `accepted` means Bird has the send and is preparing to deliver. `processed` means Bird has processed the message and queued it for delivery to the recipient's mail server.
	Status *EmailRecipientStatus `json:"status,omitempty"`

	// TotalLatencyMs End-to-end accept → delivered time for this recipient, in milliseconds. Null until delivered.
	TotalLatencyMs *int `json:"total_latency_ms,omitempty"`
}

type EmailRecipientBounceType string

type EmailRecipientList struct {
	// Data Page of recipient objects for this email send.
	Data []EmailRecipient `json:"data"`

	// NextCursor Cursor for the next page. Pass back as `starting_after` to advance forward. Null when no next page exists.
	NextCursor *string `json:"next_cursor"`

	// PrevCursor Cursor for the previous page. Pass back as `ending_before` to step backward. Null when no previous page exists.
	PrevCursor *string `json:"prev_cursor"`

	// RefreshCursor Refresh anchor. Pass back as `ending_before` later to fetch items that have appeared since this response. Non-null whenever `data` is non-empty; null only on an empty page. Distinct from `prev_cursor`.
	RefreshCursor *string `json:"refresh_cursor"`
}

type EmailRecipientRejectionReason string

type EmailRecipientStatus string

type EmailRejectionReason string

type EmailTag struct {
	// Name Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
	Name string `json:"name"`

	// Value Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
	Value string `json:"value"`
}

type EndingBefore = string

type Error struct {
	Error ErrorBody `json:"error"`
}

type ErrorBody struct {
	// Code Opaque, stable, unique error identifier. Never reused.
	Code string `json:"code"`

	// Details Per-field validation errors. Present only on validation_error responses.
	Details *[]ErrorDetail `json:"details,omitempty"`

	// DocUrl Stable link to the docs page for this error code.
	DocUrl string `json:"doc_url"`

	// Message Human-readable description. Not stable; clients must not parse it.
	Message string `json:"message"`

	// Name Human-readable slug for log readability. Paired with code, never replaces it.
	Name string `json:"name"`

	// Next Operations that resolve this error, in the order to try them. Present for errors with a well-defined recovery, such as unmet preconditions and conflicts.
	Next *[]ErrorNextAction `json:"next,omitempty"`

	// Param Identifies the offending field. Omitted when not applicable.
	Param *string `json:"param,omitempty"`

	// Remediation A human-readable next step to resolve this error. Present when a recovery is known.
	Remediation *string `json:"remediation,omitempty"`

	// RequestId Request correlation ID. Also returned as the X-Request-Id response header.
	RequestId string `json:"request_id"`

	// Type Broad category for coarse client branching.
	Type ErrorBodyType `json:"type"`

	// VendorCode Verbatim error code returned by a downstream system (for example, an SMTP response code from a recipient's mail server, or a payment-provider decline code). Present only when Bird is surfacing a code from an external system that the caller may want to act on directly.
	VendorCode *string `json:"vendor_code,omitempty"`
}

type ErrorBodyType string

type ErrorDetail struct {
	// Message What is wrong with this field.
	Message string `json:"message"`

	// Param Dotted field path (e.g. "to[0].email", "subject", ".").
	Param string `json:"param"`
}

type ErrorNextAction struct {
	// Description Short human-readable label for the recovery step.
	Description *string `json:"description,omitempty"`

	// Operation The operationId of a follow-up operation that resolves this error. Call it, then retry the original request.
	Operation string `json:"operation"`

	// Scope The permission scope the recovery operation requires, when it is scoped. Omitted for operations that need no scope.
	Scope *string `json:"scope,omitempty"`
}

type EventDomainFailed struct {
	// Data Event payload. The fields for this event are not yet finalized.
	Data map[string]interface{} `json:"data"`

	// Timestamp When the event occurred.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventDomainFailedType `json:"type"`
}

type EventDomainFailedType string

type EventDomainVerified struct {
	// Data Event payload. The fields for this event are not yet finalized.
	Data map[string]interface{} `json:"data"`

	// Timestamp When the event occurred.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventDomainVerifiedType `json:"type"`
}

type EventDomainVerifiedType string

type EventEmailAccepted struct {
	// Data Payload of the email.accepted event.
	Data EventEmailAcceptedData `json:"data"`

	// Timestamp Time Bird accepted the send.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailAcceptedType `json:"type"`
}

type EventEmailAcceptedData = EventEmailBase

type EventEmailAcceptedType string

type EventEmailBase struct {
	EmailId EmailID `json:"email_id"`

	// Metadata The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// Recipient Recipient address as it appeared on the envelope.
	Recipient   openapi_types.Email `json:"recipient"`
	RecipientId RecipientID         `json:"recipient_id"`

	// RecipientRole Envelope position of a recipient on an outbound email event.
	RecipientRole RecipientRole `json:"recipient_role"`

	// Tags Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags        *[]EmailTag `json:"tags"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailBounced struct {
	// Data Payload of the email.bounced event.
	Data EventEmailBouncedData `json:"data"`

	// Timestamp Time the bounce was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailBouncedType `json:"type"`
}

type EventEmailBouncedData struct {
	// BounceClass Numeric bounce classification for fine-grained deliverability triage, or null when the receiving server's response could not be classified. Lets you distinguish, for example, a DNS failure from a spam block when both would be `bounce_type: soft` or `bounce_type: block`.
	BounceClass *int `json:"bounce_class"`

	// BounceCode SMTP reply code returned by the receiving mail server, or null when none was provided.
	BounceCode *string `json:"bounce_code"`

	// BounceDescription Human-readable reason the receiving mail server gave for the bounce, or null when none was provided.
	BounceDescription *string `json:"bounce_description"`

	// BounceType Bounce classification. `hard` is a permanent failure (invalid address or non-existent domain). `soft` is a transient failure (mailbox full, server temporarily unavailable). `block` indicates the receiving mail server blocked the sending IP for reputation reasons. `admin` indicates an administrative refusal (relaying denied, blocklisted domain). `undetermined` is used when the receiving server's response is ambiguous.
	BounceType EmailBounceType `json:"bounce_type"`
	EmailId    EmailID         `json:"email_id"`

	// Metadata The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// Recipient Recipient address as it appeared on the envelope.
	Recipient   openapi_types.Email `json:"recipient"`
	RecipientId RecipientID         `json:"recipient_id"`

	// RecipientRole Envelope position of a recipient on an outbound email event.
	RecipientRole RecipientRole `json:"recipient_role"`

	// SendingIp The IP address used to send this message, or null when it is not known.
	SendingIp *string `json:"sending_ip"`

	// Tags Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags        *[]EmailTag `json:"tags"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailBouncedType string

type EventEmailCanceled struct {
	// Data Payload of the email.canceled event.
	Data EventEmailCanceledData `json:"data"`

	// Timestamp Time the scheduled send was canceled.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailCanceledType `json:"type"`
}

type EventEmailCanceledData = EventEmailMessageBase

type EventEmailCanceledType string

type EventEmailClicked struct {
	// Data Payload of the email.clicked event.
	Data EventEmailClickedData `json:"data"`

	// Timestamp Time the click was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailClickedType `json:"type"`
}

type EventEmailClickedData struct {
	EmailId EmailID `json:"email_id"`

	// IpAddress IP address of the client that clicked the link, or null when it is not known.
	IpAddress *string `json:"ip_address"`

	// Metadata The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// Recipient Recipient address as it appeared on the envelope.
	Recipient   openapi_types.Email `json:"recipient"`
	RecipientId RecipientID         `json:"recipient_id"`

	// RecipientRole Envelope position of a recipient on an outbound email event.
	RecipientRole RecipientRole `json:"recipient_role"`

	// Tags Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags *[]EmailTag `json:"tags"`

	// Url The URL the recipient clicked.
	Url string `json:"url"`

	// UserAgent User-agent string of the client that clicked the link, or null when it is not known.
	UserAgent   *string     `json:"user_agent"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailClickedType string

type EventEmailComplained struct {
	// Data Payload of the email.complained event.
	Data EventEmailComplainedData `json:"data"`

	// Timestamp Time the complaint was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailComplainedType `json:"type"`
}

type EventEmailComplainedData struct {
	EmailId EmailID `json:"email_id"`

	// FeedbackType The kind of feedback the mailbox provider reported (such as `abuse` or `fraud`), or null when the provider did not specify one.
	FeedbackType *string `json:"feedback_type"`

	// Metadata The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// Recipient Recipient address as it appeared on the envelope.
	Recipient   openapi_types.Email `json:"recipient"`
	RecipientId RecipientID         `json:"recipient_id"`

	// RecipientRole Envelope position of a recipient on an outbound email event.
	RecipientRole RecipientRole `json:"recipient_role"`

	// Tags Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags        *[]EmailTag `json:"tags"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailComplainedType string

type EventEmailDeferred struct {
	// Data Payload of the email.deferred event.
	Data EventEmailDeferredData `json:"data"`

	// Timestamp Time the deferral was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailDeferredType `json:"type"`
}

type EventEmailDeferredData struct {
	// BounceClass Numeric bounce classification for fine-grained deliverability triage, or null when the receiving server's response could not be classified. Distinguishes, for example, a greylisting deferral from a full mailbox.
	BounceClass *int `json:"bounce_class"`

	// BounceType Bounce classification. `hard` is a permanent failure (invalid address or non-existent domain). `soft` is a transient failure (mailbox full, server temporarily unavailable). `block` indicates the receiving mail server blocked the sending IP for reputation reasons. `admin` indicates an administrative refusal (relaying denied, blocklisted domain). `undetermined` is used when the receiving server's response is ambiguous.
	BounceType EmailBounceType `json:"bounce_type"`

	// DeferReason Human-readable reason the receiving mail server gave for the deferral, or null when none was provided.
	DeferReason *string `json:"defer_reason"`
	EmailId     EmailID `json:"email_id"`

	// Metadata The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// Recipient Recipient address as it appeared on the envelope.
	Recipient   openapi_types.Email `json:"recipient"`
	RecipientId RecipientID         `json:"recipient_id"`

	// RecipientRole Envelope position of a recipient on an outbound email event.
	RecipientRole RecipientRole `json:"recipient_role"`

	// SendingIp The IP address used to send this message, or null when it is not known.
	SendingIp *string `json:"sending_ip"`

	// Tags Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags        *[]EmailTag `json:"tags"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailDeferredType string

type EventEmailDelivered struct {
	// Data Payload of the email.delivered event.
	Data EventEmailDeliveredData `json:"data"`

	// Timestamp Time the recipient's mail server accepted the message.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailDeliveredType `json:"type"`
}

type EventEmailDeliveredData = EventEmailBase

type EventEmailDeliveredType string

type EventEmailListUnsubscribed struct {
	// Data Payload of the email.list_unsubscribed event.
	Data EventEmailListUnsubscribedData `json:"data"`

	// Timestamp Time the unsubscribe was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailListUnsubscribedType `json:"type"`
}

type EventEmailListUnsubscribedData = EventEmailBase

type EventEmailListUnsubscribedType string

type EventEmailMessageBase struct {
	EmailId EmailID `json:"email_id"`

	// Metadata The metadata object provided on the send request, echoed on the event so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// Tags Tags provided on the send request, echoed on the event so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags        *[]EmailTag `json:"tags"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailOpened struct {
	// Data Payload of the email.opened event.
	Data EventEmailOpenedData `json:"data"`

	// Timestamp Time the open was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailOpenedType `json:"type"`
}

type EventEmailOpenedData struct {
	EmailId EmailID `json:"email_id"`

	// IpAddress IP address of the client that opened the email, or null when it is not known.
	IpAddress *string `json:"ip_address"`

	// Metadata The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// Recipient Recipient address as it appeared on the envelope.
	Recipient   openapi_types.Email `json:"recipient"`
	RecipientId RecipientID         `json:"recipient_id"`

	// RecipientRole Envelope position of a recipient on an outbound email event.
	RecipientRole RecipientRole `json:"recipient_role"`

	// Tags Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags *[]EmailTag `json:"tags"`

	// UserAgent User-agent string of the client that opened the email, or null when it is not known.
	UserAgent   *string     `json:"user_agent"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailOpenedType string

type EventEmailOutOfBandBounce struct {
	// Data Payload of the email.out_of_band_bounce event.
	Data EventEmailOutOfBandBounceData `json:"data"`

	// Timestamp Time the bounce notification was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailOutOfBandBounceType `json:"type"`
}

type EventEmailOutOfBandBounceData struct {
	// BounceClass Numeric bounce classification for fine-grained deliverability triage, or null when the receiving server's response could not be classified.
	BounceClass *int `json:"bounce_class"`

	// BounceCode SMTP reply code returned by the receiving mail server, or null when none was provided.
	BounceCode *string `json:"bounce_code"`

	// BounceDescription Human-readable reason the receiving mail server gave for the bounce, or null when none was provided.
	BounceDescription *string `json:"bounce_description"`

	// BounceType Bounce classification. `hard` is a permanent failure (invalid address or non-existent domain). `soft` is a transient failure (mailbox full, server temporarily unavailable). `block` indicates the receiving mail server blocked the sending IP for reputation reasons. `admin` indicates an administrative refusal (relaying denied, blocklisted domain). `undetermined` is used when the receiving server's response is ambiguous.
	BounceType EmailBounceType `json:"bounce_type"`
	EmailId    EmailID         `json:"email_id"`

	// Metadata The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// Recipient Recipient address as it appeared on the envelope.
	Recipient   openapi_types.Email `json:"recipient"`
	RecipientId RecipientID         `json:"recipient_id"`

	// RecipientRole Envelope position of a recipient on an outbound email event.
	RecipientRole RecipientRole `json:"recipient_role"`

	// SendingIp The IP address used to send this message, or null when it is not known.
	SendingIp *string `json:"sending_ip"`

	// Tags Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags        *[]EmailTag `json:"tags"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailOutOfBandBounceType string

type EventEmailProcessed struct {
	// Data Payload of the email.processed event.
	Data EventEmailProcessedData `json:"data"`

	// Timestamp Time Bird processed the message and queued it for SMTP delivery.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailProcessedType `json:"type"`
}

type EventEmailProcessedData = EventEmailBase

type EventEmailProcessedType string

type EventEmailReceived struct {
	// Data Payload of the email.received event.
	Data EventEmailReceivedData `json:"data"`

	// Timestamp When Bird received the message.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailReceivedType `json:"type"`
}

type EventEmailReceivedData struct {
	// DkimPass Whether DKIM passed for the sender, or null when the result did not carry a DKIM verdict.
	DkimPass *bool `json:"dkim_pass,omitempty"`

	// DmarcPass Whether DMARC passed for the sender, or null when the result did not carry a DMARC verdict.
	DmarcPass *bool `json:"dmarc_pass,omitempty"`

	// From Envelope-from address.
	From openapi_types.Email `json:"from"`

	// InReplyTo In-Reply-To header — the Message-ID this message replies to, or null when it is not a reply.
	InReplyTo        *string               `json:"in_reply_to,omitempty"`
	InboundMessageId InboundEmailMessageID `json:"inbound_message_id"`

	// MessageId RFC 5322 Message-ID header from the sender, or null when the sender did not include one.
	MessageId *string `json:"message_id"`

	// SpamScore Spam score for the message. Always null at present; reserved for a future content-scoring capability.
	SpamScore *float32 `json:"spam_score,omitempty"`

	// SpfPass Whether SPF passed for the sender, or null when the result did not carry an SPF verdict.
	SpfPass *bool `json:"spf_pass,omitempty"`

	// Subject Subject line as received, or null when the message had no subject.
	Subject *string `json:"subject"`

	// To Recipient addresses the message was sent to.
	To          []openapi_types.Email `json:"to"`
	WorkspaceId WorkspaceID           `json:"workspace_id"`
}

type EventEmailReceivedType string

type EventEmailRejected struct {
	// Data Payload of the email.rejected event.
	Data EventEmailRejectedData `json:"data"`

	// Timestamp Time the rejection was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailRejectedType `json:"type"`
}

type EventEmailRejectedData struct {
	EmailId EmailID `json:"email_id"`

	// Metadata The metadata object provided on the send request, echoed on every event for the send so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// Recipient Recipient address as it appeared on the envelope.
	Recipient   openapi_types.Email `json:"recipient"`
	RecipientId RecipientID         `json:"recipient_id"`

	// RecipientRole Envelope position of a recipient on an outbound email event.
	RecipientRole RecipientRole `json:"recipient_role"`

	// RejectionReason Why an email was rejected before delivery.
	// `recipient_suppressed` means the recipient is on the workspace suppression list, so Bird did not attempt delivery. `transmission_failed` means the message could not be transmitted for delivery. `generation_failure` means the message could not be built for delivery (a template or content issue). `policy_rejection` means the message was refused by sending policy. `domain_unverified` means the sending domain was not verified. `quota_exceeded` means the organization's send quota was reached. `recipient_not_allowed` means a recipient was not permitted for this send (for shared onboarding-domain sends, recipients must be verified workspace members).
	RejectionReason EmailRejectionReason `json:"rejection_reason"`

	// Tags Tags provided on the send request, echoed on every event for the send so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags        *[]EmailTag `json:"tags"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailRejectedType string

type EventEmailScheduled struct {
	// Data Payload of the email.scheduled event.
	Data EventEmailScheduledData `json:"data"`

	// Timestamp Time the send was scheduled.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailScheduledType `json:"type"`
}

type EventEmailScheduledData struct {
	EmailId EmailID `json:"email_id"`

	// Metadata The metadata object provided on the send request, echoed on the event so you can correlate events with your own records. Null when the send carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`

	// ScheduledAt When the message is scheduled to send.
	ScheduledAt time.Time `json:"scheduled_at"`

	// Tags Tags provided on the send request, echoed on the event so you can route and correlate without an extra lookup. Null when the send carried no tags.
	Tags        *[]EmailTag `json:"tags"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventEmailScheduledType string

type EventEmailSuppressionCreated struct {
	// Data Event payload. The fields for this event are not yet finalized.
	Data map[string]interface{} `json:"data"`

	// Timestamp When the event occurred.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailSuppressionCreatedType `json:"type"`
}

type EventEmailSuppressionCreatedType string

type EventEmailUnsubscribed struct {
	// Data Payload of the email.unsubscribed event.
	Data EventEmailUnsubscribedData `json:"data"`

	// Timestamp Time the unsubscribe was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventEmailUnsubscribedType `json:"type"`
}

type EventEmailUnsubscribedData = EventEmailBase

type EventEmailUnsubscribedType string

type EventSMSAccepted struct {
	// Data Payload of the sms.accepted event.
	Data EventSMSAcceptedData `json:"data"`

	// Timestamp Time Bird accepted the request.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventSMSAcceptedType `json:"type"`
}

type EventSMSAcceptedData = EventSMSBase

type EventSMSAcceptedType string

type EventSMSBase struct {
	// From Sender the message was sent from — an E.164 number, an alphanumeric sender ID, or a short code.
	From string `json:"from"`

	// Metadata The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`
	SmsId    SMSMessageID            `json:"sms_id"`

	// Tags Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.
	Tags *[]SMSTag `json:"tags"`

	// To Recipient phone number in E.164 format.
	To          string      `json:"to"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventSMSDelivered struct {
	// Data Payload of the sms.delivered event.
	Data EventSMSDeliveredData `json:"data"`

	// Timestamp Time the carrier confirmed delivery.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventSMSDeliveredType `json:"type"`
}

type EventSMSDeliveredData struct {
	// Carrier Carrier that delivered the message, or null when not known.
	Carrier *string `json:"carrier"`

	// From Sender the message was sent from — an E.164 number, an alphanumeric sender ID, or a short code.
	From string `json:"from"`

	// MccMnc Mobile country code and mobile network code of the carrier, or null when not known.
	MccMnc *string `json:"mcc_mnc"`

	// Metadata The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`
	SmsId    SMSMessageID            `json:"sms_id"`

	// Tags Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.
	Tags *[]SMSTag `json:"tags"`

	// To Recipient phone number in E.164 format.
	To          string      `json:"to"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventSMSDeliveredType string

type EventSMSExpired struct {
	// Data Payload of the sms.expired event.
	Data EventSMSExpiredData `json:"data"`

	// Timestamp Time the message expired.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventSMSExpiredType `json:"type"`
}

type EventSMSExpiredData = EventSMSBase

type EventSMSExpiredType string

type EventSMSFailed struct {
	// Data Payload of the sms.failed event.
	Data EventSMSFailedData `json:"data"`

	// Timestamp Time the failure was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventSMSFailedType `json:"type"`
}

type EventSMSFailedData struct {
	// Error Failure detail for a message that could not be delivered or was rejected. Null when there is no failure.
	Error *SMSError `json:"error,omitempty"`

	// From Sender the message was sent from — an E.164 number, an alphanumeric sender ID, or a short code.
	From string `json:"from"`

	// Metadata The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`
	SmsId    SMSMessageID            `json:"sms_id"`

	// Tags Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.
	Tags *[]SMSTag `json:"tags"`

	// To Recipient phone number in E.164 format.
	To          string      `json:"to"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventSMSFailedType string

type EventSMSRejected struct {
	// Data Payload of the sms.rejected event.
	Data EventSMSRejectedData `json:"data"`

	// Timestamp Time the rejection was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventSMSRejectedType `json:"type"`
}

type EventSMSRejectedData struct {
	// Error Failure detail for a message that could not be delivered or was rejected. Null when there is no failure.
	Error *SMSError `json:"error,omitempty"`

	// From Sender the message was sent from — an E.164 number, an alphanumeric sender ID, or a short code.
	From string `json:"from"`

	// Metadata The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`
	SmsId    SMSMessageID            `json:"sms_id"`

	// Tags Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.
	Tags *[]SMSTag `json:"tags"`

	// To Recipient phone number in E.164 format.
	To          string      `json:"to"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventSMSRejectedType string

type EventSMSSent struct {
	// Data Payload of the sms.sent event.
	Data EventSMSSentData `json:"data"`

	// Timestamp Time the message was handed to the carrier.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventSMSSentType `json:"type"`
}

type EventSMSSentData struct {
	// Carrier Carrier that handled the message, or null when not known.
	Carrier *string `json:"carrier"`

	// From Sender the message was sent from — an E.164 number, an alphanumeric sender ID, or a short code.
	From string `json:"from"`

	// MccMnc Mobile country code and mobile network code of the carrier, or null when not known.
	MccMnc *string `json:"mcc_mnc"`

	// Metadata The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`
	SmsId    SMSMessageID            `json:"sms_id"`

	// Tags Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.
	Tags *[]SMSTag `json:"tags"`

	// To Recipient phone number in E.164 format.
	To          string      `json:"to"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventSMSSentType string

type EventSMSUndelivered struct {
	// Data Payload of the sms.undelivered event.
	Data EventSMSUndeliveredData `json:"data"`

	// Timestamp Time the non-delivery was recorded.
	Timestamp time.Time `json:"timestamp"`

	// Type Event type.
	Type EventSMSUndeliveredType `json:"type"`
}

type EventSMSUndeliveredData struct {
	// Error Failure detail for a message that could not be delivered or was rejected. Null when there is no failure.
	Error *SMSError `json:"error,omitempty"`

	// From Sender the message was sent from — an E.164 number, an alphanumeric sender ID, or a short code.
	From string `json:"from"`

	// Metadata The metadata object provided on the send request, echoed on every event for the message so you can correlate events with your own records. Null when the message carried no metadata.
	Metadata *map[string]interface{} `json:"metadata"`
	SmsId    SMSMessageID            `json:"sms_id"`

	// Tags Tags provided on the send request, echoed on every event for the message so you can route and correlate without an extra lookup. Null when the message carried no tags.
	Tags *[]SMSTag `json:"tags"`

	// To Recipient phone number in E.164 format.
	To          string      `json:"to"`
	WorkspaceId WorkspaceID `json:"workspace_id"`
}

type EventSMSUndeliveredType string

type Forbidden = Error

type GetEmailMessageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *EmailMessage
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *NotFound
	JSON429      *RateLimited
	JSON500      *InternalError
}

type Gone = Error

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type IdempotencyKey = string

type InboundEmailMessageID = string

type IncludeTotal = bool

type InternalError = Error

type ListEmailMessagesParams struct {
	// Limit Maximum number of items to return per page.
	Limit *PaginationLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// StartingAfter Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
	StartingAfter *StartingAfter `form:"starting_after,omitempty" json:"starting_after,omitempty"`

	// EndingBefore Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
	EndingBefore *EndingBefore `form:"ending_before,omitempty" json:"ending_before,omitempty"`

	// CreatedAfter Return only resources created strictly after this timestamp. RFC 3339 / ISO 8601 with timezone.
	CreatedAfter *CreatedAfter `form:"created_after,omitempty" json:"created_after,omitempty"`

	// CreatedBefore Return only resources created strictly before this timestamp. RFC 3339 / ISO 8601 with timezone.
	CreatedBefore *CreatedBefore `form:"created_before,omitempty" json:"created_before,omitempty"`

	// Status Filter by aggregate delivery status.
	Status *ListEmailMessagesParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// Tag Filter by tag. Accepts `name` to match any send carrying that tag name, or `name:value` to match a specific tag pair (e.g. `category:welcome`). For filtering on arbitrary `metadata` fields, use the metadata path-filter parameters instead.
	Tag *string `form:"tag,omitempty" json:"tag,omitempty"`

	// Category Filter by category.
	Category *ListEmailMessagesParamsCategory `form:"category,omitempty" json:"category,omitempty"`

	// To Filter by recipient address. Exact match against any `to`/`cc`/`bcc` recipient on the message; normalised to lowercase before comparison.
	To *openapi_types.Email `form:"to,omitempty" json:"to,omitempty"`

	// From Filter by sender address. Exact match against the message `from` field; normalised to lowercase before comparison.
	From *openapi_types.Email `form:"from,omitempty" json:"from,omitempty"`
}

type ListEmailMessagesParamsCategory string

type ListEmailMessagesParamsStatus string

type ListEmailMessagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *EmailMessageList
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON429      *RateLimited
	JSON500      *InternalError
}

type NotFound = Error

type OrderDesc string

type PaginationLimit = int

type PayloadTooLarge = Error

type PaymentRequired = Error

type PreconditionFailed = Error

type RateLimited = Error

type RecipientID = string

type RecipientRole string

type RequestEditorFn func(ctx context.Context, req *http.Request) error

type SMSError struct {
	// CarrierErrorCode Raw carrier-supplied error code, when available, for low-level debugging.
	CarrierErrorCode *string `json:"carrier_error_code,omitempty"`

	// Code Bird-stable failure reason. `invalid_destination` — the number is not assigned, ported out, or malformed. `unreachable` — handset off or out of coverage. `blocked_by_carrier` — the carrier filtered the message. `blocked_by_recipient` — the recipient device blocked the sender. `landline_unreachable` — the destination is a landline that does not accept SMS. `content_rejected` — the carrier rejected the content. `sender_unregistered` — the sender is not registered for the destination. `recipient_opted_out` — the recipient is on a suppression list. `provider_unavailable` — an upstream failure after retries. `unknown` — an unmapped failure.
	Code SMSErrorCode `json:"code"`

	// Description Human-readable explanation of the failure.
	Description string `json:"description"`

	// OccurredAt When the failure occurred.
	OccurredAt time.Time `json:"occurred_at"`
}

type SMSErrorCode string

type SMSMessageID = string

type SMSTag struct {
	// Name Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
	Name string `json:"name"`

	// Value Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
	Value string `json:"value"`
}

type ServiceUnavailable = Error

type StartingAfter = string

type Suppression struct {
	// AppliesTo Blocking policy. "all" blocks every category. "non_transactional" blocks marketing and future non-transactional categories but allows transactional. "category" is reserved for category-specific preferences.
	AppliesTo SuppressionAppliesTo `json:"applies_to"`
	CreatedAt *time.Time           `json:"created_at,omitempty"`
	Email     openapi_types.Email  `json:"email"`
	Id        SuppressionID        `json:"id"`
	Origin    SuppressionOrigin    `json:"origin"`
	Reason    SuppressionReason    `json:"reason"`
	Scope     SuppressionScope     `json:"scope"`

	// SourceEmailId ID of the email that triggered suppression. Null for manual additions.
	SourceEmailId *EmailID `json:"source_email_id,omitempty"`

	// SourceRecipientId ID of the recipient event that triggered suppression. Null for manual additions.
	SourceRecipientId *RecipientID `json:"source_recipient_id,omitempty"`
}

type SuppressionAppliesTo string

type SuppressionCreate struct {
	// Email Email address to suppress. Normalized to lowercase before storage.
	Email openapi_types.Email `json:"email"`
}

type SuppressionID = string

type SuppressionList struct {
	Data []Suppression `json:"data"`

	// NextCursor Cursor for the next page. Pass back as `starting_after` to advance forward. Null when no next page exists.
	NextCursor *string `json:"next_cursor"`

	// PrevCursor Cursor for the previous page. Pass back as `ending_before` to step backward. Null when no previous page exists.
	PrevCursor *string `json:"prev_cursor"`

	// RefreshCursor Refresh anchor. Pass back as `ending_before` later to fetch items that have appeared since this response. Non-null whenever `data` is non-empty; null only on an empty page. Distinct from `prev_cursor`.
	RefreshCursor *string `json:"refresh_cursor"`
}

type SuppressionOrigin string

type SuppressionReason string

type SuppressionScope struct {
	// Id Public ID or alias of the scoped resource. For workspace scope, this is the workspace ID (ws_ prefix).
	Id string `json:"id"`

	// Type The scope this suppression applies to. Suppressions are currently workspace-scoped; the other scope types are reserved for future use.
	Type SuppressionScopeType `json:"type"`
}

type SuppressionScopeType string

type Timestamps struct {
	CreatedAt *time.Time `json:"created_at,omitempty"`
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
}

type TooEarly = Error

type Unauthorized = Error

type UnderscoreListEnvelope struct {
	// NextCursor Cursor for the next page. Pass back as `starting_after` to advance forward. Null when no next page exists.
	NextCursor *string `json:"next_cursor"`

	// PrevCursor Cursor for the previous page. Pass back as `ending_before` to step backward. Null when no previous page exists.
	PrevCursor *string `json:"prev_cursor"`

	// RefreshCursor Refresh anchor. Pass back as `ending_before` later to fetch items that have appeared since this response. Non-null whenever `data` is non-empty; null only on an empty page. Distinct from `prev_cursor`.
	RefreshCursor *string `json:"refresh_cursor"`
}

type UnderscoreListEnvelopeWithTotal struct {
	// NextCursor Cursor for the next page. Pass back as `starting_after` to advance forward. Null when no next page exists.
	NextCursor *string `json:"next_cursor"`

	// PrevCursor Cursor for the previous page. Pass back as `ending_before` to step backward. Null when no previous page exists.
	PrevCursor *string `json:"prev_cursor"`

	// RefreshCursor Refresh anchor. Pass back as `ending_before` later to fetch items that have appeared since this response. Non-null whenever `data` is non-empty; null only on an empty page. Distinct from `prev_cursor`.
	RefreshCursor *string `json:"refresh_cursor"`

	// Total Total number of items matching the request's filters across all pages. Present only when `include_total=true` was passed; otherwise null.
	Total *int64 `json:"total,omitempty"`
}

type Unprocessable = Error

type WebhookAttempt struct {
	// AttemptedAt When the delivery attempt was made.
	AttemptedAt *time.Time `json:"attempted_at,omitempty"`

	// EventId Bird's source event ID, stable across retries of the same event. Null only for older attempts recorded before event IDs were available.
	EventId *WebhookEventID `json:"event_id,omitempty"`

	// EventType Webhook event type. Open enum — new event types may be added over time, so treat any unrecognized value as a future event rather than an error. The values below are the types known at this version.
	EventType WebhookEventType `json:"event_type"`

	// Id Unique identifier for this delivery attempt.
	Id *string `json:"id,omitempty"`

	// ResponseBody Body returned by your endpoint, truncated when oversized. Empty string when no body was returned.
	ResponseBody *string `json:"response_body,omitempty"`

	// ResponseDurationMs Round-trip duration in milliseconds.
	ResponseDurationMs int `json:"response_duration_ms"`

	// ResponseStatusCode HTTP status returned by the receiver. Null when no response was received (timeout, connection error, DNS failure).
	ResponseStatusCode *int `json:"response_status_code"`

	// Status Current state of the delivery attempt. `pending` covers in-flight and sending attempts; `failed` is reserved for terminal failures.
	Status WebhookAttemptStatus `json:"status"`

	// Url The endpoint URL the attempt targeted.
	Url string `json:"url"`
}

type WebhookAttemptList struct {
	Data []WebhookAttempt `json:"data"`
}

type WebhookAttemptStatus string

type WebhookEndpoint struct {
	CreatedAt   *time.Time `json:"created_at,omitempty"`
	Description *string    `json:"description,omitempty"`

	// Events Concrete event types this endpoint is subscribed to.
	Events    []WebhookEventType     `json:"events"`
	Id        WebhookEndpointID      `json:"id"`
	Status    *WebhookEndpointStatus `json:"status,omitempty"`
	UpdatedAt *time.Time             `json:"updated_at,omitempty"`
	Url       string                 `json:"url"`
}

type WebhookEndpointCreate struct {
	// Description Human-readable label for this endpoint.
	Description *string `json:"description,omitempty"`

	// Events Concrete event types to subscribe to.
	Events []WebhookEventType `json:"events"`

	// Url HTTPS URL to deliver events to.
	Url string `json:"url"`
}

type WebhookEndpointCreated struct {
	CreatedAt   *time.Time `json:"created_at,omitempty"`
	Description *string    `json:"description,omitempty"`

	// Events Concrete event types this endpoint is subscribed to.
	Events []WebhookEventType `json:"events"`
	Id     WebhookEndpointID  `json:"id"`

	// Secret Signing secret (whsec_ prefix). Present in this response only — store it immediately, it cannot be retrieved again.
	Secret    string                        `json:"secret" pii:"true"`
	Status    *WebhookEndpointCreatedStatus `json:"status,omitempty"`
	UpdatedAt *time.Time                    `json:"updated_at,omitempty"`
	Url       string                        `json:"url"`
}

type WebhookEndpointCreatedStatus string

type WebhookEndpointID = string

type WebhookEndpointList struct {
	Data []WebhookEndpoint `json:"data"`

	// NextCursor Cursor for the next page. Pass back as `starting_after` to advance forward. Null when no next page exists.
	NextCursor *string `json:"next_cursor"`

	// PrevCursor Cursor for the previous page. Pass back as `ending_before` to step backward. Null when no previous page exists.
	PrevCursor *string `json:"prev_cursor"`

	// RefreshCursor Refresh anchor. Pass back as `ending_before` later to fetch items that have appeared since this response. Non-null whenever `data` is non-empty; null only on an empty page. Distinct from `prev_cursor`.
	RefreshCursor *string `json:"refresh_cursor"`

	// Total Total number of items matching the request's filters across all pages. Present only when `include_total=true` was passed; otherwise null.
	Total *int64 `json:"total,omitempty"`
}

type WebhookEndpointStatus string

type WebhookEndpointUpdate struct {
	// Description Human-readable label for this endpoint.
	Description *string `json:"description,omitempty"`

	// Events Replacement set of event type subscriptions.
	Events *[]WebhookEventType `json:"events,omitempty"`

	// Status Set to "active" to re-enable a paused endpoint, or "paused" to stop delivery.
	Status *WebhookEndpointUpdateStatus `json:"status,omitempty"`

	// Url New HTTPS URL to deliver events to.
	Url *string `json:"url,omitempty"`
}

type WebhookEndpointUpdateStatus string

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

type WebhookEventID = string

type WebhookEventType = string

type WebhookReplayRequest struct {
	// Since Replay events created at or after this timestamp. Defaults to 24h ago when omitted.
	Since *time.Time `json:"since,omitempty"`

	// Until Replay events created before or at this timestamp. Omit to bound only by `since`.
	Until *time.Time `json:"until,omitempty"`
}

type WebhookRotateSecretResponse struct {
	// Secret The new signing secret (whsec_ prefix). Store this immediately — it is not shown again.
	Secret string `json:"secret" pii:"true"`
}

type WebhookTestRequest struct {
	// EventType Event type to simulate. Defaults to a generic test ping if omitted.
	EventType *string `json:"event_type,omitempty"`
}

type WebhookTestResponse struct {
	// Error A short explanation of why the event could not be delivered. Present only when your endpoint could not be reached.
	Error *string `json:"error,omitempty"`

	// EventPayload Discriminated union of every webhook event the Bird platform emits.
	// Each variant is the full delivery body: `type` names the event, `timestamp` is when the event occurred, and `data` carries the event-specific payload. The `type` property selects the variant — SDKs that consume this schema (openapi-typescript, oapi-codegen) generate a narrowed union keyed on `type`, so customer code can switch on the event id and access the variant-specific payload fields without casting.
	// Delivery metadata (the event id and per-attempt signature headers) rides in HTTP headers per Standard Webhooks and is handled by the SDK's webhook verification helper, which returns one of these variants.
	EventPayload *WebhookEvent `json:"event_payload,omitempty"`

	// ResponseBody Response body returned by your endpoint, truncated when oversized. Empty when no body was returned.
	ResponseBody *string `json:"response_body,omitempty"`

	// ResponseDurationMs Round-trip delivery latency in milliseconds.
	ResponseDurationMs int `json:"response_duration_ms"`

	// ResponseStatusCode HTTP status returned by your endpoint. Null when no response was received (timeout, connection error, DNS failure).
	ResponseStatusCode *int `json:"response_status_code"`

	// Status Whether your endpoint accepted the test event. `delivered` means it returned a 2xx status; `failed` means it returned a non-2xx status or could not be reached.
	Status WebhookTestResponseStatus `json:"status"`
}

type WebhookTestResponseStatus string

type WorkspaceID = string