audit

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 {
	// ListEventTypes request
	ListEventTypes(ctx context.Context, params *ListEventTypesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	RecordEventWithApplicationVndAPIPlusJSONBody(ctx context.Context, params *RecordEventParams, body RecordEventApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEvent request
	GetEvent(ctx context.Context, eventId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListForwarderTypesApiV1ForwarderTypesGet request
	ListForwarderTypesApiV1ForwarderTypesGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetForwarderTypeApiV1ForwarderTypesIdGet request
	GetForwarderTypeApiV1ForwarderTypesIdGet(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateForwarderWithApplicationVndAPIPlusJSONBody(ctx context.Context, body CreateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteForwarder request
	DeleteForwarder(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetForwarder request
	GetForwarder(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateForwarderWithBody request with any body
	UpdateForwarderWithBody(ctx context.Context, forwarderId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateForwarderWithApplicationVndAPIPlusJSONBody(ctx context.Context, forwarderId openapi_types.UUID, body UpdateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetryFailedForwarderDeliveries request
	RetryFailedForwarderDeliveries(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListForwarderDeliveries request
	ListForwarderDeliveries(ctx context.Context, forwarderId openapi_types.UUID, params *ListForwarderDeliveriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetryForwarderDelivery request
	RetryForwarderDelivery(ctx context.Context, forwarderId openapi_types.UUID, deliveryId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	ExecuteTestForwarder(ctx context.Context, body ExecuteTestForwarderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	SearchEvents(ctx context.Context, body SearchEventsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListUsage request
	ListUsage(ctx context.Context, params *ListUsageParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// ListEventTypesWithResponse request
	ListEventTypesWithResponse(ctx context.Context, params *ListEventTypesParams, reqEditors ...RequestEditorFn) (*ListEventTypesResponse, error)

	// ListEventsWithResponse request
	ListEventsWithResponse(ctx context.Context, params *ListEventsParams, reqEditors ...RequestEditorFn) (*ListEventsResponse, error)

	// RecordEventWithBodyWithResponse request with any body
	RecordEventWithBodyWithResponse(ctx context.Context, params *RecordEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RecordEventResponse, error)

	RecordEventWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, params *RecordEventParams, body RecordEventApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*RecordEventResponse, error)

	// GetEventWithResponse request
	GetEventWithResponse(ctx context.Context, eventId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetEventResponse, error)

	// ListForwarderTypesApiV1ForwarderTypesGetWithResponse request
	ListForwarderTypesApiV1ForwarderTypesGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListForwarderTypesApiV1ForwarderTypesGetResponse, error)

	// GetForwarderTypeApiV1ForwarderTypesIdGetWithResponse request
	GetForwarderTypeApiV1ForwarderTypesIdGetWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetForwarderTypeApiV1ForwarderTypesIdGetResponse, error)

	// ListForwardersWithResponse request
	ListForwardersWithResponse(ctx context.Context, params *ListForwardersParams, reqEditors ...RequestEditorFn) (*ListForwardersResponse, error)

	// CreateForwarderWithBodyWithResponse request with any body
	CreateForwarderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateForwarderResponse, error)

	CreateForwarderWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, body CreateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateForwarderResponse, error)

	// DeleteForwarderWithResponse request
	DeleteForwarderWithResponse(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteForwarderResponse, error)

	// GetForwarderWithResponse request
	GetForwarderWithResponse(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetForwarderResponse, error)

	// UpdateForwarderWithBodyWithResponse request with any body
	UpdateForwarderWithBodyWithResponse(ctx context.Context, forwarderId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateForwarderResponse, error)

	UpdateForwarderWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, forwarderId openapi_types.UUID, body UpdateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateForwarderResponse, error)

	// RetryFailedForwarderDeliveriesWithResponse request
	RetryFailedForwarderDeliveriesWithResponse(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*RetryFailedForwarderDeliveriesResponse, error)

	// ListForwarderDeliveriesWithResponse request
	ListForwarderDeliveriesWithResponse(ctx context.Context, forwarderId openapi_types.UUID, params *ListForwarderDeliveriesParams, reqEditors ...RequestEditorFn) (*ListForwarderDeliveriesResponse, error)

	// RetryForwarderDeliveryWithResponse request
	RetryForwarderDeliveryWithResponse(ctx context.Context, forwarderId openapi_types.UUID, deliveryId openapi_types.UUID, reqEditors ...RequestEditorFn) (*RetryForwarderDeliveryResponse, error)

	// ExecuteTestForwarderWithBodyWithResponse request with any body
	ExecuteTestForwarderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteTestForwarderResponse, error)

	ExecuteTestForwarderWithResponse(ctx context.Context, body ExecuteTestForwarderJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteTestForwarderResponse, error)

	// ListResourceTypesWithResponse request
	ListResourceTypesWithResponse(ctx context.Context, params *ListResourceTypesParams, reqEditors ...RequestEditorFn) (*ListResourceTypesResponse, error)

	// SearchEventsWithBodyWithResponse request with any body
	SearchEventsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchEventsResponse, error)

	SearchEventsWithResponse(ctx context.Context, body SearchEventsJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchEventsResponse, error)

	// ListUsageWithResponse request
	ListUsageWithResponse(ctx context.Context, params *ListUsageParams, reqEditors ...RequestEditorFn) (*ListUsageResponse, error)
}

type CreateForwarderApplicationVndAPIPlusJSONRequestBody = ForwarderRequest

type CreateForwarderResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON201 *ForwarderResponse
}

type DeleteForwarderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

type Event struct {
	// ActorId Identifier of the actor that caused the event. Free-form string — any identifier scheme is accepted.
	ActorId *string `json:"actor_id,omitempty"`

	// ActorLabel Human-readable label for the actor (e.g. an email address or API key name) at the time the event was recorded.
	ActorLabel *string `json:"actor_label,omitempty"`

	// ActorType Kind of actor that caused the event, e.g. `USER`, `API_KEY`, `SYSTEM`, or any other label you choose. Free-form string; the API does not constrain or interpret it.
	ActorType *string `json:"actor_type,omitempty"`

	// CreatedAt When the event was received and recorded.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Data Free-form payload attached to the event. Use it for resource snapshots (by convention under `data.snapshot`), request identifiers, or any other context the event needs to carry.
	Data *map[string]interface{} `json:"data,omitempty"`

	// Description Free-text description of the event. Included alongside `resource_id` in the `filter[search]` substring target.
	Description *string `json:"description,omitempty"`

	// DoNotForward When `true`, the event is recorded but not delivered to any forwarder. A delivery log entry with status `SKIPPED_DO_NOT_FORWARD` is written for each enabled forwarder so the skip is visible in the delivery log.
	DoNotForward *bool `json:"do_not_forward,omitempty"`

	// EventType What happened, e.g. `user.created`. Any non-empty string.
	EventType string `json:"event_type"`

	// IdempotencyKey The idempotency key used to deduplicate the record. Echoes the `Idempotency-Key` header if one was supplied, otherwise a key derived from the event's content.
	IdempotencyKey *string `json:"idempotency_key,omitempty"`

	// OccurredAt When the event actually happened. Defaults to the server receipt time (`created_at`).
	OccurredAt *time.Time `json:"occurred_at,omitempty"`

	// ResourceId Identifier of the specific resource the event is about.
	ResourceId string `json:"resource_id"`

	// ResourceType Kind of resource the event is about, e.g. `user`. Any non-empty string.
	ResourceType string `json:"resource_type"`
}

type EventListLinks struct {
	Next *string `json:"next,omitempty"`
}

type EventListMeta struct {
	PageSize int `json:"page_size"`
}

type EventListResponse struct {
	Data  []EventResource `json:"data"`
	Links *EventListLinks `json:"links,omitempty"`

	// Meta Cursor-pagination meta for the audit-event list endpoint.
	//
	// Audit events are append-only at high cardinality (millions of rows
	// per account at production tenants), so this endpoint stays on
	// cursor pagination — the documented exception in ADR-014. Every
	// other read-many endpoint in the platform follows the standard
	// offset convention (`page[number]` / `page[size]`).
	Meta EventListMeta `json:"meta"`
}

type EventRequest struct {
	// Data JSON:API resource envelope for an audit event.
	//
	// `id` must not be specified for create requests (the server assigns it).
	Data EventResource `json:"data"`
}

type EventResource struct {
	// Attributes An audit event — a record that something happened, attributed to
	// an actor and a resource.
	//
	// When recording a snapshot of the resource at the time of the event,
	// place it inside `data`. smplkit's own integrations nest it under
	// `data.snapshot`, but the slot is yours to use however you like.
	Attributes Event   `json:"attributes"`
	Id         *string `json:"id,omitempty"`
	Type       *string `json:"type,omitempty"`
}

type EventResponse struct {
	// Data JSON:API resource envelope for an audit event.
	//
	// `id` must not be specified for create requests (the server assigns it).
	Data EventResource `json:"data"`
}

type EventSearchListLinks struct {
	// Next Opaque cursor token for the next page. POST the same body with `page[after]` set to this value to fetch the next page. Unlike the URL-form `links.next` returned by `GET /api/v1/events`, this is a bare cursor token — the client must re-issue a POST with its body, which the URL form cannot capture.
	Next *string `json:"next,omitempty"`
}

type EventSearchListMeta struct {
	PageSize int `json:"page_size"`

	// Scan Scan statistics for a search response.
	//
	// Exposed so a selective JSON Logic filter doesn't silently look like
	// "0 matches" when the truth is "the scan ceiling was reached before
	// the filter had a chance to find page[size] matches."
	Scan EventSearchScanMeta `json:"scan"`
}

type EventSearchRequest struct {
	// Filter Optional JSON Logic expression evaluated against each row after column filters narrow the candidate set. Null, absent, or an empty object disables JSON Logic filtering. When present, the search is silently capped to the last 30 days by `occurred_at` (intersected with any explicit `filter[occurred_at]` the caller supplied).
	Filter *map[string]interface{} `json:"filter,omitempty"`

	// FilterActorId Exact match on the event's `actor_id` field.
	FilterActorId *string `json:"filter[actor_id],omitempty"`

	// FilterActorType Exact match on the event's `actor_type` field.
	FilterActorType *string `json:"filter[actor_type],omitempty"`

	// FilterDoNotForward When set, restrict to events whose `do_not_forward` flag matches the given boolean. Forwarder previews typically pass `false` to match live-pipeline semantics (events flagged `do_not_forward=true` are skipped by the forwarder pipeline).
	FilterDoNotForward *bool `json:"filter[do_not_forward],omitempty"`

	// FilterEventType Exact match on the event's `event_type` field.
	FilterEventType *string `json:"filter[event_type],omitempty"`

	// FilterOccurredAt Date range using interval notation, e.g. `[2026-04-01T00:00:00Z,2026-04-15T00:00:00Z)`. Required by `filter[search]` when the resource pair isn't provided. When a JSON Logic `filter` is present, the effective range is intersected with the last 30 days.
	FilterOccurredAt *string `json:"filter[occurred_at],omitempty"`

	// FilterResourceId Exact match on the event's `resource_id` field. Must be accompanied by `filter[resource_type]`.
	FilterResourceId *string `json:"filter[resource_id],omitempty"`

	// FilterResourceType Exact match on the event's `resource_type` field.
	FilterResourceType *string `json:"filter[resource_type],omitempty"`

	// FilterSearch Case-insensitive substring match on `resource_id` or `description`. Must be accompanied by either `filter[occurred_at]` or `filter[resource_type]` + `filter[resource_id]`.
	FilterSearch *string `json:"filter[search],omitempty"`

	// PageAfter Opaque cursor — pass the previous response's `links.next` cursor verbatim to fetch the next page. Keep the same `sort` value across paginated requests.
	PageAfter *string `json:"page[after],omitempty"`

	// PageSize Maximum events to return. Range 1..1000, default 1000 — matches every other list / search endpoint on the platform. Set explicitly to a smaller value when the consumer is rendering results card-by-card.
	PageSize *int `json:"page[size],omitempty"`

	// Sort Sort field: `occurred_at` or `created_at`, optionally prefixed with `-` for descending order. Default `-occurred_at` (newest first).
	Sort *string `json:"sort,omitempty"`
}

type EventSearchResponse struct {
	Data  []EventResource       `json:"data"`
	Links *EventSearchListLinks `json:"links,omitempty"`

	// Meta Cursor-pagination + scan meta for the search response.
	//
	// Mirrors `EventListMeta` (cursor pagination — `page_size` is the
	// only pagination field) and adds the `scan` block above.
	Meta EventSearchListMeta `json:"meta"`
}

type EventSearchScanMeta struct {
	// Exhausted `true` if the server hit the per-request scan ceiling before finding `page[size]` matches. When true, paginate again with the returned `links.next` cursor to continue scanning past the ceiling.
	Exhausted bool `json:"exhausted"`

	// Matched Rows the JSON Logic expression matched. Equal to `len(data)` for the page being returned plus any matches found beyond the page size.
	Matched int `json:"matched"`

	// Scanned Rows scanned after column filters narrowed the candidate set, before the JSON Logic expression was applied.
	Scanned int `json:"scanned"`
}

type EventTypeAttributes struct {
	// CreatedAt First sighting of this event_type for the account. When the request includes “filter[resource_type]“, this is the first sighting of the (event_type, resource_type) triple rather than the event_type overall.
	CreatedAt time.Time `json:"created_at"`

	// EventType The event_type slug. Same as the JSON:API “id“.
	EventType string `json:"event_type"`
}

type EventTypeListResponse struct {
	Data []EventTypeResource `json:"data"`

	// Meta Top-level “meta“ block included on every JSON:API list response.
	Meta ListMeta `json:"meta"`
}

type EventTypeResource struct {
	Attributes EventTypeAttributes `json:"attributes"`

	// Id The event_type slug.
	Id   string  `json:"id"`
	Type *string `json:"type,omitempty"`
}

type ExecuteTestForwarderJSONRequestBody = TestForwarderRequest

type ExecuteTestForwarderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TestForwarderResponse
}

type Forwarder struct {
	// Configuration HTTP request configuration used to deliver an event to the destination.
	//
	// Used when the parent forwarder's “forwarder_type“ is one of the
	// HTTP-family destinations (“HTTP“, “DATADOG“, “SPLUNK_HEC“,
	// “SUMO_LOGIC“, “NEW_RELIC“, “HONEYCOMB“, “ELASTIC“). When other
	// transports land (“FTP“, “SQS“, …) their own configuration schemas
	// will join this one as members of a discriminated union under the
	// “configuration“ field of “Forwarder“.
	Configuration HttpConfiguration `json:"configuration"`

	// CreatedAt When the forwarder was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// DeletedAt When the forwarder was deleted. `null` for active forwarders.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`

	// Description Free-text description for the forwarder.
	Description *string `json:"description,omitempty"`

	// Enabled Whether the forwarder is currently delivering events. Set to `false` to pause deliveries without deleting the forwarder.
	Enabled *bool `json:"enabled,omitempty"`

	// Filter JSON Logic expression evaluated against each event. The event is delivered only if the expression returns truthy. Omit to deliver every event.
	Filter *map[string]interface{} `json:"filter,omitempty"`

	// ForwarderType Supported forwarder destination types (ADR-050).
	ForwarderType ForwarderType `json:"forwarder_type"`

	// Name Human-readable name for the forwarder. Must contain at least one non-whitespace character.
	Name string `json:"name"`

	// Transform Template applied to each event before delivery. The shape depends on “transform_type“: for `JSONATA`, a string containing a JSONata expression. Omit to deliver the event JSON unchanged.
	Transform interface{} `json:"transform,omitempty"`

	// TransformType Engine used to evaluate “transform“. Must be set whenever “transform“ is set. Today only `JSONATA` is supported.
	TransformType *ForwarderTransformType `json:"transform_type,omitempty"`

	// UpdatedAt When the forwarder was last modified.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`

	// Version Monotonic counter incremented on every update, starting at 1.
	Version *int `json:"version,omitempty"`
}

type ForwarderDelivery struct {
	// AttemptNumber 1 for the initial delivery, incremented for each retry.
	AttemptNumber int `json:"attempt_number"`

	// CreatedAt When the delivery attempt was recorded.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Error Error message if the delivery did not complete.
	Error *string `json:"error,omitempty"`

	// EventId Event that was being delivered.
	EventId openapi_types.UUID `json:"event_id"`

	// ForwarderId Forwarder the delivery belongs to.
	ForwarderId openapi_types.UUID `json:"forwarder_id"`

	// LatencyMs Elapsed time of the delivery attempt in milliseconds.
	LatencyMs *int `json:"latency_ms,omitempty"`

	// Request The HTTP request as it was sent to the destination. Header values are redacted.
	Request *map[string]interface{} `json:"request,omitempty"`

	// ResponseBody Response body returned by the destination.
	ResponseBody *string `json:"response_body,omitempty"`

	// ResponseStatus HTTP status code returned by the destination.
	ResponseStatus *int `json:"response_status,omitempty"`

	// Status Delivery outcome. `SUCCEEDED` and `FAILED` are the live-delivery outcomes; `FILTERED_OUT` is recorded when the forwarder's filter rejected the event; `SKIPPED_DO_NOT_FORWARD` is recorded when the event was emitted with `do_not_forward=true`.
	Status ForwarderDeliveryStatus `json:"status"`
}

type ForwarderDeliveryListLinks struct {
	Next *string `json:"next,omitempty"`
}

type ForwarderDeliveryListMeta struct {
	PageSize int `json:"page_size"`
}

type ForwarderDeliveryListResponse struct {
	Data  []ForwarderDeliveryResource `json:"data"`
	Links *ForwarderDeliveryListLinks `json:"links,omitempty"`

	// Meta Cursor-pagination meta for the forwarder-delivery log endpoint.
	//
	// Forwarder deliveries are append-only at high cardinality (one row per
	// delivery attempt per event) and scroll with the same workload as
	// audit events, so this endpoint stays on cursor pagination — the
	// documented exception in ADR-014. The parent `/forwarders` collection
	// follows the standard offset convention.
	Meta ForwarderDeliveryListMeta `json:"meta"`
}

type ForwarderDeliveryResource struct {
	// Attributes A log entry for one attempt to deliver an event to a forwarder.
	Attributes ForwarderDelivery `json:"attributes"`
	Id         string            `json:"id"`
	Type       *string           `json:"type,omitempty"`
}

type ForwarderDeliveryResponse struct {
	// Data JSON:API resource envelope for a forwarder delivery log entry.
	Data ForwarderDeliveryResource `json:"data"`
}

type ForwarderDeliveryStatus string

type ForwarderListResponse struct {
	Data []ForwarderResource `json:"data"`

	// Meta Top-level “meta“ block included on every JSON:API list response.
	Meta ListMeta `json:"meta"`
}

type ForwarderRequest struct {
	// Data JSON:API resource envelope for a forwarder.
	//
	// `id` must not be specified for create requests (the server assigns it).
	Data ForwarderResource `json:"data"`
}

type ForwarderResource struct {
	// Attributes A destination that receives audit events recorded for the account.
	//
	// Each event recorded for the account is evaluated against every enabled
	// forwarder. If the filter expression evaluates truthy — or is absent —
	// the event is shaped by the configured transform and delivered to the
	// destination defined by “configuration“.
	Attributes Forwarder `json:"attributes"`
	Id         *string   `json:"id,omitempty"`
	Type       *string   `json:"type,omitempty"`
}

type ForwarderResponse struct {
	// Data JSON:API resource envelope for a forwarder.
	//
	// `id` must not be specified for create requests (the server assigns it).
	Data ForwarderResource `json:"data"`
}

type ForwarderTransformType string

type ForwarderType string

type ForwarderTypeAttributes struct {
	// BaseType Transport family — today only `HTTP`. New base types will add their own configuration shape and runtime handler.
	BaseType string `json:"base_type"`

	// Configuration HTTP-base-type delivery template.
	Configuration ForwarderTypeHttpConfiguration `json:"configuration"`

	// DocsUrl Link to the vendor's own documentation for this destination.
	DocsUrl *string `json:"docs_url,omitempty"`

	// Icon Absolute URL to the icon asset, served by audit at `/api/v1/forwarder_types/{id}/icon`.
	Icon string `json:"icon"`

	// IsCustom True for the synthetic `http` Custom HTTP entry, which has no vendor template — the customer supplies URL, headers, and transform from scratch. False for branded types.
	IsCustom bool `json:"is_custom"`

	// Name Human-readable label shown in the type-picker.
	Name string `json:"name"`

	// Placeholders UI metadata keyed by placeholder name. Each `{name}` token appearing in `configuration` (URL, header value) has a matching entry here describing how to prompt for it.
	Placeholders map[string]ForwarderTypePlaceholder `json:"placeholders"`

	// Transform Default transform shipped with the type.
	Transform *ForwarderTypeTransform `json:"transform,omitempty"`
}

type ForwarderTypeHeader struct {
	// Name Header name.
	Name string `json:"name"`

	// Value Header value template. Strings of the form `{name}` are placeholders the customer fills in; look up `name` in `placeholders` for the UI metadata.
	Value string `json:"value"`
}

type ForwarderTypeHttpConfiguration struct {
	// Headers Headers attached to each delivery request.
	Headers []ForwarderTypeHeader `json:"headers"`

	// Method HTTP method.
	Method string `json:"method"`

	// SuccessStatus HTTP response status indicating a successful delivery — either a specific code (`200`, `204`) or a class (`2xx`).
	SuccessStatus string `json:"success_status"`

	// Url URL template. `null` for the synthetic `http` (Custom HTTP) entry, where the customer supplies the URL from scratch. May contain `{name}` placeholders that map to the `placeholders` block.
	Url *string `json:"url"`
}

type ForwarderTypeListResponse struct {
	Data []ForwarderTypeResource `json:"data"`

	// Meta Top-level “meta“ block included on every JSON:API list response.
	Meta ListMeta `json:"meta"`
}

type ForwarderTypePlaceholder struct {
	// Default Pre-selected value when `enum` is set, or the default for a free-text field.
	Default *string `json:"default,omitempty"`

	// Enum If set, the value must be one of the listed strings — render as a dropdown.
	Enum *[]string `json:"enum,omitempty"`

	// Label Human-readable label for the input.
	Label string `json:"label"`

	// Placeholder HTML-input hint text shown when the field is empty.
	Placeholder *string `json:"placeholder,omitempty"`

	// Secret If true, mask the value in the UI and treat as a credential.
	Secret *bool `json:"secret,omitempty"`
}

type ForwarderTypeResource struct {
	// Attributes The catalog entry's attributes — one branded forwarder type or the
	// synthetic Custom HTTP entry.
	Attributes ForwarderTypeAttributes `json:"attributes"`

	// Id Lowercase forwarder type id — matches `forwarder.forwarder_type` values and is the filename stem of `forwarder_types/<id>.yaml`.
	Id   string  `json:"id"`
	Type *string `json:"type,omitempty"`
}

type ForwarderTypeResponse struct {
	// Data JSON:API resource envelope for a forwarder type.
	Data ForwarderTypeResource `json:"data"`
}

type ForwarderTypeTransform struct {
	// Default Default template; customers can override per forwarder.
	Default string `json:"default"`

	// Type Engine name. Today only `JSONATA`.
	Type string `json:"type"`
}

type GetEventResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *EventResponse
}

type GetForwarderResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderResponse
}

type GetForwarderTypeApiV1ForwarderTypesIdGetResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderTypeResponse
}

type HttpConfiguration struct {
	// Headers HTTP headers attached to each delivery request.
	Headers *[]HttpHeader `json:"headers,omitempty"`

	// Method HTTP method used when delivering an event.
	Method *HttpConfigurationMethod `json:"method,omitempty"`

	// SuccessStatus HTTP response status that indicates a successful delivery. Either a specific status code (e.g. `200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).
	SuccessStatus *string `json:"success_status,omitempty"`

	// Url Destination URL. Must be an absolute `http://` or `https://` URL with a hostname (e.g. `https://siem.example.com/in`).
	Url string `json:"url"`
}

type HttpConfigurationMethod string

type HttpHeader struct {
	// Name Header name.
	Name string `json:"name"`

	// Value Header value. Stored encrypted at rest; returned as plaintext on `GET`.
	Value string `json:"value"`
}

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

type ListEventTypesParams struct {
	FilterResourceType *string `form:"filter[resource_type],omitempty" json:"filter[resource_type],omitempty"`

	// Sort Field to sort by. Prefix with `-` for descending order. Default: `key`. Allowed values: `key`, `-key`.
	Sort *ListEventTypesParamsSort `form:"sort,omitempty" json:"sort,omitempty"`

	// PageNumber 1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error.
	PageNumber *int `form:"page[number],omitempty" json:"page[number],omitempty"`

	// PageSize Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error.
	PageSize *int `form:"page[size],omitempty" json:"page[size],omitempty"`

	// MetaTotal When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`.
	MetaTotal *bool `form:"meta[total],omitempty" json:"meta[total],omitempty"`
}

type ListEventTypesParamsSort string

type ListEventTypesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *EventTypeListResponse
}

type ListEventsParams struct {
	FilterOccurredAt   *string `form:"filter[occurred_at],omitempty" json:"filter[occurred_at],omitempty"`
	FilterActorType    *string `form:"filter[actor_type],omitempty" json:"filter[actor_type],omitempty"`
	FilterActorId      *string `form:"filter[actor_id],omitempty" json:"filter[actor_id],omitempty"`
	FilterEventType    *string `form:"filter[event_type],omitempty" json:"filter[event_type],omitempty"`
	FilterResourceType *string `form:"filter[resource_type],omitempty" json:"filter[resource_type],omitempty"`
	FilterResourceId   *string `form:"filter[resource_id],omitempty" json:"filter[resource_id],omitempty"`

	// FilterSearch Case-insensitive substring match against `resource_id` or `description`. Use `filter[resource_id]` for an exact match on `resource_id`.
	FilterSearch *string `form:"filter[search],omitempty" json:"filter[search],omitempty"`

	// FilterDoNotForward When set, restrict to events whose `do_not_forward` flag matches the given boolean. Forwarder previews typically pass `false` to match live-pipeline semantics (events flagged `do_not_forward=true` are skipped by the forwarder pipeline).
	FilterDoNotForward *bool   `form:"filter[do_not_forward],omitempty" json:"filter[do_not_forward],omitempty"`
	PageSize           *int    `form:"page[size],omitempty" json:"page[size],omitempty"`
	PageAfter          *string `form:"page[after],omitempty" json:"page[after],omitempty"`

	// Sort Field to sort by. Prefix with `-` for descending order. Default: `-occurred_at`. Allowed values: `created_at`, `-created_at`, `occurred_at`, `-occurred_at`.
	Sort *ListEventsParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
}

type ListEventsParamsSort string

type ListEventsResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *EventListResponse
}

type ListForwarderDeliveriesParams struct {
	FilterStatus    *string `form:"filter[status],omitempty" json:"filter[status],omitempty"`
	FilterCreatedAt *string `form:"filter[created_at],omitempty" json:"filter[created_at],omitempty"`
	FilterEventId   *string `form:"filter[event_id],omitempty" json:"filter[event_id],omitempty"`
	PageSize        *int    `form:"page[size],omitempty" json:"page[size],omitempty"`
	PageAfter       *string `form:"page[after],omitempty" json:"page[after],omitempty"`

	// Sort Field to sort by. Prefix with `-` for descending order. Default: `-created_at`. Allowed values: `created_at`, `-created_at`.
	Sort *ListForwarderDeliveriesParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
}

type ListForwarderDeliveriesParamsSort string

type ListForwarderDeliveriesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderDeliveryListResponse
}

type ListForwarderTypesApiV1ForwarderTypesGetResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderTypeListResponse
}

type ListForwardersParams struct {
	FilterForwarderType *string `form:"filter[forwarder_type],omitempty" json:"filter[forwarder_type],omitempty"`
	FilterEnabled       *bool   `form:"filter[enabled],omitempty" json:"filter[enabled],omitempty"`

	// Sort Field to sort by. Prefix with `-` for descending order. Default: `-created_at`. Allowed values: `created_at`, `-created_at`, `updated_at`, `-updated_at`.
	Sort *ListForwardersParamsSort `form:"sort,omitempty" json:"sort,omitempty"`

	// PageNumber 1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error.
	PageNumber *int `form:"page[number],omitempty" json:"page[number],omitempty"`

	// PageSize Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error.
	PageSize *int `form:"page[size],omitempty" json:"page[size],omitempty"`

	// MetaTotal When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`.
	MetaTotal *bool `form:"meta[total],omitempty" json:"meta[total],omitempty"`
}

type ListForwardersParamsSort string

type ListForwardersResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderListResponse
}

type ListMeta struct {
	// Pagination Pagination block returned inside “meta“ on every list response.
	//
	// “page“ and “size“ are always present and echo the parameters that
	// served the response (their defaults when the client omitted them).
	// “total“ and “total_pages“ are present only when the request included
	// “meta[total]=true“.
	Pagination PaginationMeta `json:"pagination"`
}

type ListResourceTypesParams struct {
	// Sort Field to sort by. Prefix with `-` for descending order. Default: `key`. Allowed values: `key`, `-key`.
	Sort *ListResourceTypesParamsSort `form:"sort,omitempty" json:"sort,omitempty"`

	// PageNumber 1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error.
	PageNumber *int `form:"page[number],omitempty" json:"page[number],omitempty"`

	// PageSize Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error.
	PageSize *int `form:"page[size],omitempty" json:"page[size],omitempty"`

	// MetaTotal When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`.
	MetaTotal *bool `form:"meta[total],omitempty" json:"meta[total],omitempty"`
}

type ListResourceTypesParamsSort string

type ListResourceTypesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ResourceTypeListResponse
}

type ListUsageParams struct {
	// FilterPeriod Period to report. `current` is the only supported value.
	FilterPeriod string `form:"filter[period]" json:"filter[period]"`

	// PageNumber 1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error.
	PageNumber *int `form:"page[number],omitempty" json:"page[number],omitempty"`

	// PageSize Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error.
	PageSize *int `form:"page[size],omitempty" json:"page[size],omitempty"`

	// MetaTotal When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`.
	MetaTotal *bool `form:"meta[total],omitempty" json:"meta[total],omitempty"`
}

type ListUsageResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *UsageResponse
}

type PaginationMeta struct {
	// Page 1-based page number returned.
	Page int `json:"page"`

	// Size Number of items per page.
	Size int `json:"size"`

	// Total Total number of matching items across all pages. Present only when the request included `meta[total]=true`.
	Total *int `json:"total,omitempty"`

	// TotalPages Total number of pages at the requested page size. Present only when the request included `meta[total]=true`.
	TotalPages *int `json:"total_pages,omitempty"`
}

type RecordEventApplicationVndAPIPlusJSONRequestBody = EventRequest

type RecordEventParams struct {
	IdempotencyKey *string `json:"Idempotency-Key,omitempty"`
}

type RecordEventResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *EventResponse
	ApplicationvndApiJSON201 *EventResponse
}

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

type ResourceTypeAttributes struct {
	// CreatedAt First sighting of this resource_type for the account.
	CreatedAt time.Time `json:"created_at"`

	// ResourceType The resource_type slug. Same as the JSON:API “id“.
	ResourceType string `json:"resource_type"`
}

type ResourceTypeListResponse struct {
	Data []ResourceTypeResource `json:"data"`

	// Meta Top-level “meta“ block included on every JSON:API list response.
	Meta ListMeta `json:"meta"`
}

type ResourceTypeResource struct {
	Attributes ResourceTypeAttributes `json:"attributes"`

	// Id The resource_type slug.
	Id   string  `json:"id"`
	Type *string `json:"type,omitempty"`
}

type RetryFailedDeliveriesSummary struct {
	// Attempted Number of failed deliveries that were re-attempted.
	Attempted int `json:"attempted"`

	// Failed Number of re-attempts that failed again.
	Failed int `json:"failed"`

	// Succeeded Number of re-attempts that succeeded.
	Succeeded int `json:"succeeded"`
}

type RetryFailedForwarderDeliveriesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *RetryFailedDeliveriesSummary
}

type RetryForwarderDeliveryResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderDeliveryResponse
}

type SearchEventsJSONRequestBody = EventSearchRequest

type SearchEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *EventSearchResponse
}

type TestForwarderRequest struct {
	// Body Request body sent to the destination. When omitted, an empty body is sent (suitable for connectivity probes). When set, the body is sent verbatim — pair with an appropriate `Content-Type` entry in `headers` so the destination interprets it correctly. Limit 1 MiB.
	Body *string `json:"body,omitempty"`

	// Headers HTTP headers attached to the test request.
	Headers *[]HttpHeader `json:"headers,omitempty"`

	// Method HTTP method used for the test request.
	Method *TestForwarderRequestMethod `json:"method,omitempty"`

	// SuccessStatus HTTP response status that indicates success. Either a specific status code (e.g. `200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).
	SuccessStatus *string `json:"success_status,omitempty"`

	// TimeoutMs Per-request timeout in milliseconds. Capped at 30 seconds.
	TimeoutMs *int `json:"timeout_ms,omitempty"`

	// Url Destination URL. Must be an absolute `http://` or `https://` URL with a hostname (e.g. `https://siem.example.com/in`).
	Url string `json:"url"`
}

type TestForwarderRequestMethod string

type TestForwarderResponse struct {
	// Error Error message if the request did not complete.
	Error *string `json:"error,omitempty"`

	// LatencyMs Elapsed time of the request in milliseconds.
	LatencyMs *int `json:"latency_ms"`

	// ResponseBody Response body returned by the destination.
	ResponseBody *string `json:"response_body,omitempty"`

	// ResponseHeaders Headers returned by the destination.
	ResponseHeaders *map[string]string `json:"response_headers,omitempty"`

	// ResponseStatus HTTP status code returned by the destination.
	ResponseStatus *int `json:"response_status"`

	// Succeeded True if the destination responded with a status matching `success_status`.
	Succeeded bool `json:"succeeded"`
}

type UpdateForwarderApplicationVndAPIPlusJSONRequestBody = ForwarderRequest

type UpdateForwarderResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderResponse
}

type UsageAttributes struct {
	// LimitKey Identifier of the metered limit, e.g. `audit.events_per_month`.
	LimitKey string `json:"limit_key"`

	// Period Period the counter covers. `current` is the only supported value.
	Period string `json:"period"`

	// Value Count for the period.
	Value int `json:"value"`
}

type UsageResource struct {
	// Attributes Usage counter for a single metered limit.
	Attributes UsageAttributes `json:"attributes"`
	Id         string          `json:"id"`
	Type       *string         `json:"type,omitempty"`
}

type UsageResponse struct {
	Data []UsageResource `json:"data"`

	// Meta Top-level “meta“ block included on every JSON:API list response.
	Meta ListMeta `json:"meta"`
}