flashduty

package module
v0.15.0 Latest Latest
Warning

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

 Go to latest Published: Sep 6, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

README

go-flashduty

The official Go client for the Flashduty Open API — a thin, typed SDK covering every Flashduty REST endpoint.

📖 API reference: https://docs.flashcat.cloud/en/openapi/introduction

Status: All 304 Open API operations across 34 services are generated from the Flashduty OpenAPI specification, covered by unit tests, and validated end-to-end against the live API.

Install

go get github.com/flashcatcloud/go-flashduty

Requires Go 1.24+.

Quick start

package main

import (
	"context"
	"fmt"
	"log"

	flashduty "github.com/flashcatcloud/go-flashduty"
)

func main() {
	client, err := flashduty.NewClient("YOUR_APP_KEY")
	if err != nil {
		log.Fatal(err)
	}

	list, resp, err := client.Incidents.List(context.Background(), &flashduty.ListIncidentsRequest{
		Progress:    "Triggered",
		ListOptions: flashduty.ListOptions{Limit: 20},
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("request_id=%s total=%d has_next=%t\n", resp.RequestID, resp.Total, resp.HasNextPage)
	for _, inc := range list.Items {
		fmt.Printf("[%s] %s\n", inc.IncidentSeverity, inc.Title)
	}
}

Design

  • Thin and typed. Every method maps to exactly one HTTP call and returns (*T, *Response, error). No hidden cross-endpoint enrichment.
  • Service-grouped. Endpoints are organized into services on the client (client.Incidents, client.Alerts, …), generated from the OpenAPI specification.
  • Composable transport. Cross-cutting concerns (retry, caching, tracing, rate-limit handling) compose as http.RoundTripper middleware via WithTransport.
  • Human-readable timestamps. Response time fields are typed Timestamp (Unix seconds) or TimestampMilli (milliseconds) instead of bare integers, so JSON, logs, and LLM-facing output read as RFC3339 — while the raw epoch is one call away. Request fields stay plain int64.
Options
client, err := flashduty.NewClient("YOUR_APP_KEY",
	flashduty.WithBaseURL("https://api.flashcat.cloud"),
	flashduty.WithTimeout(10*time.Second),
	flashduty.WithUserAgent("my-app/1.0"),
	flashduty.WithHTTPClient(customHTTPClient),
	flashduty.WithTransport(customRoundTripper),
	flashduty.WithLogger(myLogger),
	flashduty.WithRequestHeaders(staticHeaders),
	flashduty.WithRequestHook(func(req *http.Request) { /* e.g. inject traceparent */ }),
)
Errors and rate limits
_, _, err := client.Incidents.Info(ctx, &flashduty.IncidentInfoRequest{IncidentID: "does-not-exist"})

var apiErr *flashduty.ErrorResponse
if errors.As(err, &apiErr) {
	fmt.Println(apiErr.Code, apiErr.RequestID)
}

var rl *flashduty.RateLimitError
if errors.As(err, &rl) {
	time.Sleep(rl.RetryAfter)
}

Typed predicates save you the string comparison and see through wrapped errors (errors.As under the hood):

if flashduty.IsNotFound(err) { /* ... */ }
if flashduty.IsRateLimited(err) { /* ... */ }
switch flashduty.ErrorCodeOf(err) {
case flashduty.ErrorCodeAccessDenied, flashduty.ErrorCodeUnauthorized:
	// handle auth failures
}
Timestamps

Time fields on responses are Timestamp (Unix seconds) or TimestampMilli (milliseconds). They marshal to an RFC3339 string in the local timezone and unmarshal from either a numeric epoch or an RFC3339 string, so a value round-trips cleanly. The zero value stays the numeric 0 sentinel (never a 1970 date) and is dropped by omitempty.

inc := list.Items[0]
fmt.Println(inc.StartTime)          // 2026-05-30T14:37:11+08:00  (String / fmt / TOON)
b, _ := json.Marshal(inc.StartTime) // "2026-05-30T14:37:11+08:00"
epoch := inc.StartTime.Unix()       // 1779514631  (raw wire value)
t := inc.StartTime.Time()           // time.Time

Request time fields stay plain int64 — the API expects a numeric epoch on the wire (note: most endpoints take seconds, but RUM and webhook-history endpoints take milliseconds).

Retries

Automatic retries are not built into the core. Compose them at the transport layer with the optional retry subpackage — a safe-by-default retrying http.RoundTripper (retries 429 and 5xx, honors Retry-After, deterministic exponential backoff, and only replays requests whose body is replayable, which all SDK requests are):

import "github.com/flashcatcloud/go-flashduty/retry"

client, err := flashduty.NewClient("YOUR_APP_KEY",
	flashduty.WithTransport(retry.New(
		retry.WithMaxRetries(3),
	)),
)

License

Apache-2.0

Documentation

Overview

Package flashduty is the official Go client for the Flashduty Open API (https://flashcat.cloud). It is a thin, typed wrapper: every method maps to exactly one HTTP call, returns (*T, *Response, error), and performs no hidden cross-endpoint enrichment.

Create a client with an app key: 

client, err := flashduty.NewClient("APP_KEY")
if err != nil {
	// handle error
}

Endpoints are grouped into services on the client, e.g. client.Incidents.List(ctx, &flashduty.IncidentListRequest{...}). Most are POST actions; a few read endpoints are GET with query parameters. Services are added by the code generator; see internal/cmd/gen.

Cross-cutting transport concerns (retry, caching, tracing, rate-limit handling) compose as http.RoundTripper middleware via WithTransport. The optional retry subpackage provides a safe-by-default retrying transport.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool added in v0.5.0 

func Bool(v bool) *bool

Bool returns a pointer to v.

func Float64 added in v0.5.0 

func Float64(v float64) *float64

Float64 returns a pointer to v.

func Int added in v0.5.0 

func Int(v int) *int

Int returns a pointer to v.

func Int64 added in v0.5.0 

func Int64(v int64) *int64

Int64 returns a pointer to v.

func IsAccessDenied 

func IsAccessDenied(err error) bool

IsAccessDenied reports whether err carries the AccessDenied API error code.

func IsInvalidParameter 

func IsInvalidParameter(err error) bool

IsInvalidParameter reports whether err carries the InvalidParameter API error code.

func IsNotFound 

func IsNotFound(err error) bool

IsNotFound reports whether err carries the ResourceNotFound API error code.

func IsRateLimited 

func IsRateLimited(err error) bool

IsRateLimited reports whether err represents a rate-limit condition.

It returns true when the error chain contains a *RateLimitError (regardless of the code it carries) or when the resolved code is RequestTooFrequently.

func IsUnauthorized 

func IsUnauthorized(err error) bool

IsUnauthorized reports whether err carries the Unauthorized API error code.

func NewExportScanner added in v0.5.4 

func NewExportScanner(r io.Reader) *bufio.Scanner

NewExportScanner wraps an export stream in a bufio.Scanner configured to read one NDJSON line per Scan, with a buffer large enough for the wide event lines (tool output, llm calls) that the transcript can contain. Each token is one raw JSON line; decode it with DecodeExportLine or json.Unmarshal into ExportLine. 

rc, _, err := client.Sessions.Export(ctx, req)
if err != nil { return err }
defer rc.Close()
sc := flashduty.NewExportScanner(rc)
for sc.Scan() {
    line, err := flashduty.DecodeExportLine(sc.Bytes())
    // ... handle line, or write sc.Bytes() straight to a file ...
}
return sc.Err()

func String added in v0.5.0 

func String(v string) *string

String returns a pointer to v.

func Uint64 added in v0.5.0 

func Uint64(v uint64) *uint64

Uint64 returns a pointer to v.

Types

type A2aAgentCreateRequest added in v0.4.0 

type A2aAgentCreateRequest struct {
	// Agent display name.
	AgentName string `json:"agent_name" toon:"agent_name"`
	// Allow non-loopback HTTP OAuth discovery/metadata endpoints for this agent instead of requiring HTTPS. Defaults to false.
	AllowInsecureOauthHTTP bool `json:"allow_insecure_oauth_http,omitempty" toon:"allow_insecure_oauth_http,omitempty"`
	// Skip TLS certificate verification when connecting to this agent's endpoint (self-signed/private certs). Defaults to false.
	AllowInsecureTlsSkipVerify bool `json:"allow_insecure_tls_skip_verify,omitempty" toon:"allow_insecure_tls_skip_verify,omitempty"`
	// Authentication config key-values, e.g. the API key or bearer token. Values under credential-looking keys (name containing KEY, SECRET, TOKEN, PASSWORD, etc.) are masked back in responses.
	AuthConfig map[string]string `json:"auth_config,omitempty" toon:"auth_config,omitempty"`
	// Authentication mode: `shared` (default) shares one credential across all users; `per_user_secret` requires `secret_schema.header_name`; `per_user_oauth` runs per-user OAuth.
	AuthMode string `json:"auth_mode,omitempty" toon:"auth_mode,omitempty"`
	// Authentication type for reaching the remote agent: `none` (default when omitted), `api_key`, or `bearer`.
	AuthType string `json:"auth_type,omitempty" toon:"auth_type,omitempty"`
	// URL of the remote agent card. Must be an absolute `http` or `https` URL with a non-empty host; reachability is enforced by the execution environment, not at creation time.
	CardURL string `json:"card_url" toon:"card_url"`
	// Execution environments this agent is callable from: `cloud` and/or BYOC runner environment IDs. Omitted or empty means all environments.
	Environments []string `json:"environments,omitempty" toon:"environments,omitempty"`
	// Natural-language instructions for the remote agent: a Markdown document with optional `summary` frontmatter and a non-empty body, at most 50 KiB (51200 bytes). Required — a deprecated `description` field is still accepted for legacy clients and, if both are sent, must exactly match `instructions`.
	Instructions string `json:"instructions" toon:"instructions"`
	// JSON-encoded OAuth metadata; populated by the OAuth discovery flow for `per_user_oauth` mode.
	OauthMetadata string `json:"oauth_metadata,omitempty" toon:"oauth_metadata,omitempty"`
	// JSON-encoded secret schema, e.g. `{"header_name":"X-Api-Key"}`; required when `auth_mode=per_user_secret`.
	SecretSchema string `json:"secret_schema,omitempty" toon:"secret_schema,omitempty"`
	// Whether the remote agent supports streaming.
	Streaming bool `json:"streaming,omitempty" toon:"streaming,omitempty"`
	// Team scope: 0 = account-wide; >0 = team. Creating at account scope requires the owner/admin role; creating into a team requires actual membership in that team.
	TeamID int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
}

A2aAgentCreateRequest is generated from the Flashduty OpenAPI schema.

type A2aAgentCreateResponse added in v0.4.0 

type A2aAgentCreateResponse struct {
	// ID of the newly created agent.
	AgentID string `json:"agent_id" toon:"agent_id"`
}

A2aAgentCreateResponse is generated from the Flashduty OpenAPI schema.

type A2aAgentIDRequest added in v0.4.0 

type A2aAgentIDRequest struct {
	// Target agent ID, from the list returned by `POST /safari/a2a-agent/list`.
	AgentID string `json:"agent_id" toon:"agent_id"`
}

A2aAgentIDRequest is generated from the Flashduty OpenAPI schema.

type A2aAgentItem added in v0.4.0 

type A2aAgentItem struct {
	// Owning account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Agent name resolved from the remote card. Omitted until the card has been fetched.
	AgentCardName string `json:"agent_card_name" toon:"agent_card_name"`
	// Skills advertised by the remote card. Omitted until the card has been fetched.
	AgentCardSkills []string `json:"agent_card_skills" toon:"agent_card_skills"`
	// Unique A2A agent ID (prefix `a2a_`).
	AgentID string `json:"agent_id" toon:"agent_id"`
	// Agent display name.
	AgentName string `json:"agent_name" toon:"agent_name"`
	// Allow non-loopback HTTP OAuth discovery/metadata endpoints for this agent instead of requiring HTTPS.
	AllowInsecureOauthHTTP bool `json:"allow_insecure_oauth_http" toon:"allow_insecure_oauth_http"`
	// Skip TLS certificate verification when connecting to this agent's endpoint.
	AllowInsecureTlsSkipVerify bool `json:"allow_insecure_tls_skip_verify" toon:"allow_insecure_tls_skip_verify"`
	// Authentication config key-values. Values under credential-looking keys (name containing KEY, SECRET, TOKEN, PASSWORD, etc.) are masked. Omitted when empty.
	AuthConfig map[string]string `json:"auth_config" toon:"auth_config"`
	// Authentication mode. One of: `shared` (a single static credential saved on the resource and shared by all callers in the account; the default — an empty value behaves the same), `per_user_secret` (each user stores their own secret per `secret_schema`, injected per user at runtime), `per_user_oauth` (each user completes their own OAuth grant; discovery and registration run lazily on first use).
	AuthMode string `json:"auth_mode" toon:"auth_mode"`
	// Authentication type for reaching the remote agent: `none`, `api_key`, or `bearer`. Rows created before validation was tightened may return an empty string, equivalent to `none`.
	AuthType string `json:"auth_type" toon:"auth_type"`
	// Whether the caller may edit this agent.
	CanEdit bool `json:"can_edit" toon:"can_edit"`
	// Card-resolution timeout in seconds. Always 0 today — the API does not yet expose a way to set it.
	CardResolveTimeout int64 `json:"card_resolve_timeout" toon:"card_resolve_timeout"`
	// URL of the remote agent card.
	CardURL string `json:"card_url" toon:"card_url"`
	// Creation time. Unix timestamp in milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Member ID that created the agent.
	CreatedBy int64 `json:"created_by" toon:"created_by"`
	// Execution environments this agent is callable from (`cloud` and/or BYOC runner environment IDs). Always present; `[]` means all environments (also the value on legacy rows created before this field).
	Environments []string `json:"environments" toon:"environments"`
	// Natural-language instructions for the remote agent (formerly named `description`).
	Instructions string `json:"instructions" toon:"instructions"`
	// JSON-encoded OAuth metadata (per_user_oauth mode).
	OauthMetadata string `json:"oauth_metadata" toon:"oauth_metadata"`
	// JSON-encoded secret schema (per_user_secret mode).
	SecretSchema string `json:"secret_schema" toon:"secret_schema"`
	// Agent status.
	Status string `json:"status" toon:"status"`
	// Whether the remote agent supports streaming responses.
	Streaming bool `json:"streaming" toon:"streaming"`
	// Single-task execution timeout in seconds. Always 0 today — the API does not yet expose a way to set it.
	TaskTimeout int64 `json:"task_timeout" toon:"task_timeout"`
	// Team scope: 0 = account-wide; >0 = the owning team.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Last update time. Unix timestamp in milliseconds.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
}

A2aAgentItem is generated from the Flashduty OpenAPI schema.

type A2aAgentListRequest added in v0.4.0 

type A2aAgentListRequest struct {
	// Include account-scoped (team_id=0) rows. Defaults to true.
	IncludeAccount *bool `json:"include_account,omitempty" toon:"include_account,omitempty"`
	// Page size.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
	// Pagination offset — number of rows to skip, starting from 0.
	Offset int64 `json:"offset,omitempty" toon:"offset,omitempty"`
	// Case-insensitive substring search across agent name, instructions, card URL, agent ID, and the resolved card name.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Visibility scope: `all` (account-scope plus the caller's visible teams), `account` (account-scope only), or `team` (team-scoped rows across the caller's visible teams).
	Scope string `json:"scope,omitempty" toon:"scope,omitempty"`
	// Filter to these team IDs; empty = the caller's visible set.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

A2aAgentListRequest is generated from the Flashduty OpenAPI schema.

type A2aAgentListResponse added in v0.4.0 

type A2aAgentListResponse struct {
	// A2A agents on this page.
	Items []A2aAgentItem `json:"items" toon:"items"`
	// Total number of matching agents.
	Total int64 `json:"total" toon:"total"`
}

A2aAgentListResponse is generated from the Flashduty OpenAPI schema.

type A2aAgentUpdateRequest added in v0.4.0 

type A2aAgentUpdateRequest struct {
	// Target agent ID, from the list returned by `POST /safari/a2a-agent/list`.
	AgentID string `json:"agent_id" toon:"agent_id"`
	// New display name. Omit to leave unchanged.
	AgentName *string `json:"agent_name,omitempty" toon:"agent_name,omitempty"`
	// Toggle non-loopback HTTP OAuth discovery for this agent. Omit to leave unchanged.
	AllowInsecureOauthHTTP *bool `json:"allow_insecure_oauth_http,omitempty" toon:"allow_insecure_oauth_http,omitempty"`
	// Toggle TLS certificate verification skipping for this agent. Omit to leave unchanged.
	AllowInsecureTlsSkipVerify *bool `json:"allow_insecure_tls_skip_verify,omitempty" toon:"allow_insecure_tls_skip_verify,omitempty"`
	// Replace the whole auth config; omit to leave unchanged. Keys missing from the map are dropped. For a sensitive key, sending back the masked value keeps the stored secret, while sending an empty string clears it.
	AuthConfig map[string]string `json:"auth_config,omitempty" toon:"auth_config,omitempty"`
	// New auth mode: shared, per_user_secret, or per_user_oauth. Changing it always rewrites secret_schema together with it.
	AuthMode *string `json:"auth_mode,omitempty" toon:"auth_mode,omitempty"`
	// New auth type: `none`, `api_key`, or `bearer`. Omit to leave unchanged.
	AuthType *string `json:"auth_type,omitempty" toon:"auth_type,omitempty"`
	// New card URL. Omit to leave unchanged.
	CardURL *string `json:"card_url,omitempty" toon:"card_url,omitempty"`
	// Execution environments this agent is callable from: `cloud` and/or BYOC runner environment IDs. Omit (null) to leave unchanged; send a list to set it — an empty list clears the restriction back to all environments.
	Environments []string `json:"environments,omitempty" toon:"environments,omitempty"`
	// New instructions document (same contract as create: optional `summary` frontmatter, non-empty body, at most 50 KiB). Omit to leave unchanged. A deprecated `description` field is also accepted; if both are sent they must match.
	Instructions *string `json:"instructions,omitempty" toon:"instructions,omitempty"`
	// New JSON OAuth metadata. If omitted while auth_mode changes, it is cleared to empty.
	OauthMetadata *string `json:"oauth_metadata,omitempty" toon:"oauth_metadata,omitempty"`
	// New JSON secret schema.
	SecretSchema *string `json:"secret_schema,omitempty" toon:"secret_schema,omitempty"`
	// Toggle streaming support. Omit to leave unchanged.
	Streaming *bool `json:"streaming,omitempty" toon:"streaming,omitempty"`
	// Reassign team scope. Omit to leave unchanged. Reassigning requires rights on the destination team; if the team changes without also sending a new environment binding, the existing runner binding must remain selectable by the caller or the update is rejected.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
}

A2aAgentUpdateRequest is generated from the Flashduty OpenAPI schema.

type A2aAgentsService added in v0.4.0 

type A2aAgentsService service

A2aAgentsService handles the "AI SRE/A2A agents" API resource.

func (*A2aAgentsService) ReadGet added in v0.4.0 

func (s *A2aAgentsService) ReadGet(ctx context.Context, req *A2aAgentIDRequest) (*A2aAgentItem, *Response, error)

Get A2A agent detail.

Get one A2A agent by ID.

API: POST /safari/a2a-agent/get (remote-agent-read-get).

func (*A2aAgentsService) ReadList added in v0.4.0 

func (s *A2aAgentsService) ReadList(ctx context.Context, req *A2aAgentListRequest) (*A2aAgentListResponse, *Response, error)

List A2A agents.

List A2A agents visible to the caller across account and team scopes, with pagination.

API: POST /safari/a2a-agent/list (remote-agent-read-list).

func (*A2aAgentsService) WriteCreate added in v0.4.0 

func (s *A2aAgentsService) WriteCreate(ctx context.Context, req *A2aAgentCreateRequest) (*A2aAgentCreateResponse, *Response, error)

Create A2A agent.

Register a new A2A remote agent from its agent-card URL.

API: POST /safari/a2a-agent/create (remote-agent-write-create).

func (*A2aAgentsService) WriteDelete added in v0.4.0 

func (s *A2aAgentsService) WriteDelete(ctx context.Context, req *A2aAgentIDRequest) (*any, *Response, error)

Delete A2A agent.

Soft-delete an A2A agent by ID.

API: POST /safari/a2a-agent/delete (remote-agent-write-delete).

func (*A2aAgentsService) WriteDisable added in v0.4.0 

func (s *A2aAgentsService) WriteDisable(ctx context.Context, req *A2aAgentIDRequest) (*any, *Response, error)

Disable A2A agent.

Disable an enabled A2A agent.

API: POST /safari/a2a-agent/disable (remote-agent-write-disable).

func (*A2aAgentsService) WriteEnable added in v0.4.0 

func (s *A2aAgentsService) WriteEnable(ctx context.Context, req *A2aAgentIDRequest) (*any, *Response, error)

Enable A2A agent.

Enable a disabled A2A agent.

API: POST /safari/a2a-agent/enable (remote-agent-write-enable).

func (*A2aAgentsService) WriteUpdate added in v0.4.0 

func (s *A2aAgentsService) WriteUpdate(ctx context.Context, req *A2aAgentUpdateRequest) (*any, *Response, error)

Update A2A agent.

Apply a partial update to an A2A agent. Omit a field to leave it unchanged.

API: POST /safari/a2a-agent/update (remote-agent-write-update).

type AccountInfo added in v0.4.0 

type AccountInfo struct {
	// Account identifier.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Account name.
	AccountName string `json:"account_name" toon:"account_name"`
	// Account avatar URL.
	Avatar string `json:"avatar" toon:"avatar"`
	// ISO 3166-1 alpha-2 region code of the contact phone (e.g. "CN", "US", "HK").
	CountryCode string `json:"country_code" toon:"country_code"`
	// Account creation time, Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Primary account domain (login subdomain).
	Domain string `json:"domain" toon:"domain"`
	// Account contact email.
	Email string `json:"email" toon:"email"`
	// Additional account domains.
	ExtraDomains []string `json:"extra_domains" toon:"extra_domains"`
	// Account language preference (e.g. zh-CN, en-US).
	Locale string `json:"locale" toon:"locale"`
	// Account identifier on the marketplace platform. Omitted together with `mp_plat`.
	MpAccountID string `json:"mp_account_id" toon:"mp_account_id"`
	// Cloud marketplace platform the account was provisioned from. Omitted when the account did not come from a marketplace.
	MpPlat string `json:"mp_plat" toon:"mp_plat"`
	// Account contact phone, masked for privacy.
	Phone string `json:"phone" toon:"phone"`
	// Account access restrictions. Omitted when none are configured.
	Restrictions AccountInfoRestrictions `json:"restrictions" toon:"restrictions"`
	// Account default timezone (IANA name, e.g. Asia/Shanghai).
	TimeZone string `json:"time_zone" toon:"time_zone"`
}

AccountInfo is generated from the Flashduty OpenAPI schema.

type AccountInfoRestrictions added in v0.4.0 

type AccountInfoRestrictions struct {
	// Whether subdomains of the allowed email domains are also accepted.
	AllowSubdomain bool `json:"allow_subdomain" toon:"allow_subdomain"`
	// Allowed login email domains.
	EmailDomains []string `json:"email_domains" toon:"email_domains"`
	// Allowed source IP/CIDR whitelist.
	Ips []string `json:"ips" toon:"ips"`
}

AccountInfoRestrictions is generated from the Flashduty OpenAPI schema.

type AccountService added in v0.4.0 

type AccountService service

AccountService handles the "Platform/Account" API resource.

func (*AccountService) Info added in v0.4.0 

func (s *AccountService) Info(ctx context.Context) (*AccountInfo, *Response, error)

Get account detail.

Return the current account's profile and settings.

API: POST /account/info (account-read-info).

type AckIncidentRequest 

type AckIncidentRequest struct {
	// Custom field values for the acknowledgement form. Allowed keys and values depend on the incident's visible form.
	CustomFields CustomFieldValues `json:"custom_fields,omitempty" toon:"custom_fields,omitempty"`
	// Images attached to the acknowledgement timeline entry.
	Images []IncidentActionImage `json:"images,omitempty" toon:"images,omitempty"`
	// Incident IDs to acknowledge. At most 100 per call.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
	// Form summary recorded as a timeline comment. Accepted only when the acknowledgement form contains a summary element.
	Summary string `json:"summary,omitempty" toon:"summary,omitempty"`
}

AckIncidentRequest is generated from the Flashduty OpenAPI schema.

type AddIncidentResponderRequest 

type AddIncidentResponderRequest struct {
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Optional notification override. Defaults to following each person's personal preference.
	Notify AddIncidentResponderRequestNotify `json:"notify,omitzero" toon:"notify,omitempty"`
	// Member IDs to add as responders.
	PersonIDs []int64 `json:"person_ids" toon:"person_ids"`
}

AddIncidentResponderRequest is generated from the Flashduty OpenAPI schema.

type AddIncidentResponderRequestNotify 

type AddIncidentResponderRequestNotify struct {
	// When false, use `personal_channels`; when true or omitted, use each responder's personal preference.
	FollowPreference *bool `json:"follow_preference,omitempty" toon:"follow_preference,omitempty"`
	// Channels to use (e.g. `voice`, `sms`, `email`).
	PersonalChannels []string `json:"personal_channels,omitempty" toon:"personal_channels,omitempty"`
	// Notification template ID (MongoDB ObjectID).
	TemplateID string `json:"template_id,omitempty" toon:"template_id,omitempty"`
}

AddIncidentResponderRequestNotify is generated from the Flashduty OpenAPI schema.

type AddWarRoomMemberRequest added in v0.4.0 

type AddWarRoomMemberRequest struct {
	// Chat ID of the war room within the IM platform.
	ChatID string `json:"chat_id" toon:"chat_id"`
	// ID of the IM integration hosting the war room; obtain it from `POST /datasource/im/war-room-enabled/list`.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Person IDs to add to the war room.
	MemberIDs []int64 `json:"member_ids" toon:"member_ids"`
}

AddWarRoomMemberRequest is generated from the Flashduty OpenAPI schema.

type AffectedStatusPageComponentItem 

type AffectedStatusPageComponentItem struct {
	// Time the component became available, as a Unix timestamp in seconds. Omitted when 0.
	AvailableSinceSeconds Timestamp `json:"available_since_seconds" toon:"available_since_seconds"`
	// Component ID. Omitted when empty.
	ComponentID string `json:"component_id" toon:"component_id"`
	// Component description. Omitted when empty.
	Description string `json:"description" toon:"description"`
	// When true, the component is hidden entirely from summary endpoints. Omitted when false.
	HideAll bool `json:"hide_all" toon:"hide_all"`
	// When true, uptime data is hidden from summary responses. Omitted when false.
	HideUptime bool `json:"hide_uptime" toon:"hide_uptime"`
	// Component display name.
	Name string `json:"name" toon:"name"`
	// Display order within its section. Omitted when 0.
	OrderID int64 `json:"order_id" toon:"order_id"`
	// Parent section ID. Omitted when the component sits at the top level.
	SectionID string `json:"section_id" toon:"section_id"`
	// Current status of the component affected by the change. Severity increases: `operational` < `degraded` = `under_maintenance` < `partial_outage` < `full_outage`; incident-type changes may use the first four, maintenance-type changes only `operational` and `under_maintenance`.
	// | Value | Meaning |
	// |---|---|
	// | `operational` | Operating normally. |
	// | `degraded` | Degraded performance. |
	// | `partial_outage` | Partial outage. |
	// | `full_outage` | Full outage. |
	// | `under_maintenance` | Under maintenance. |
	Status string `json:"status" toon:"status"`
}

AffectedStatusPageComponentItem is generated from the Flashduty OpenAPI schema.

type AlertEnrichmentService 

type AlertEnrichmentService service

AlertEnrichmentService handles the "On-call/Alert enrichment" API resource.

func (*AlertEnrichmentService) EnrichmentReadInfo 

func (s *AlertEnrichmentService) EnrichmentReadInfo(ctx context.Context, req *EnrichmentInfoRequest) (*EnrichmentItem, *Response, error)

Get enrichment rules.

Return the enrichment rule set configured for a specific integration.

API: POST /enrichment/info (enrichment-read-info).

func (*AlertEnrichmentService) EnrichmentReadList 

func (s *AlertEnrichmentService) EnrichmentReadList(ctx context.Context, req *EnrichmentListRequest) (*EnrichmentListResponse, *Response, error)

List enrichment rules.

Return the enrichment rule sets for a list of integration IDs.

API: POST /enrichment/list (enrichment-read-list).

func (*AlertEnrichmentService) EnrichmentWriteUpsert 

func (s *AlertEnrichmentService) EnrichmentWriteUpsert(ctx context.Context, req *EnrichmentUpsertRequest) (*Response, error)

Upsert enrichment rules.

Create or fully replace the enrichment rule set for an integration. The entire `rules` array is replaced atomically.

API: POST /enrichment/upsert (enrichment-write-upsert).

func (*AlertEnrichmentService) FieldReadInfo 

func (s *AlertEnrichmentService) FieldReadInfo(ctx context.Context, req *FieldInfoRequest) (*FieldItem, *Response, error)

Get field detail.

Return the configuration of a single incident custom field by ID.

API: POST /field/info (field-read-info).

func (*AlertEnrichmentService) FieldReadList 

func (s *AlertEnrichmentService) FieldReadList(ctx context.Context, req *FieldListRequest) (*FieldListResponse, *Response, error)

List fields.

Return all incident custom fields configured for the account.

API: POST /field/list (field-read-list).

func (*AlertEnrichmentService) FieldWriteCreate 

func (s *AlertEnrichmentService) FieldWriteCreate(ctx context.Context, req *CreateFieldRequest) (*CreateFieldResponse, *Response, error)

Create field.

Create a new incident custom field on the account.

API: POST /field/create (field-write-create).

func (*AlertEnrichmentService) FieldWriteDelete 

func (s *AlertEnrichmentService) FieldWriteDelete(ctx context.Context, req *DeleteFieldRequest) (*Response, error)

Delete field.

Delete an incident custom field and asynchronously strip it from existing incidents.

API: POST /field/delete (field-write-delete).

func (*AlertEnrichmentService) FieldWriteUpdate 

func (s *AlertEnrichmentService) FieldWriteUpdate(ctx context.Context, req *UpdateFieldRequest) (*Response, error)

Update field.

Update mutable attributes of an existing incident custom field.

API: POST /field/update (field-write-update).

func (*AlertEnrichmentService) MappingAPIReadInfo 

func (s *AlertEnrichmentService) MappingAPIReadInfo(ctx context.Context, req *MappingApiidRequest) (*MappingAPIItem, *Response, error)

Get mapping API detail.

Return detail of a single mapping API by its ID.

API: POST /enrichment/mapping/api/info (mapping-api-read-info).

func (*AlertEnrichmentService) MappingAPIReadList 

func (s *AlertEnrichmentService) MappingAPIReadList(ctx context.Context) (*MappingAPIListResponse, *Response, error)

List mapping APIs.

Return all mapping APIs configured for the account.

API: POST /enrichment/mapping/api/list (mapping-api-read-list).

func (*AlertEnrichmentService) MappingAPIWriteCreate 

func (s *AlertEnrichmentService) MappingAPIWriteCreate(ctx context.Context, req *MappingAPICreateRequest) (*MappingAPICreateResponse, *Response, error)

Create mapping API.

Create a new external HTTP API endpoint used to enrich alerts via HTTP lookup.

API: POST /enrichment/mapping/api/create (mapping-api-write-create).

func (*AlertEnrichmentService) MappingAPIWriteDelete 

func (s *AlertEnrichmentService) MappingAPIWriteDelete(ctx context.Context, req *MappingApiidRequest) (*Response, error)

Delete mapping API.

Delete a mapping API. Deletion is blocked if the API is referenced by any enrichment rule.

API: POST /enrichment/mapping/api/delete (mapping-api-write-delete).

func (*AlertEnrichmentService) MappingAPIWriteUpdate 

func (s *AlertEnrichmentService) MappingAPIWriteUpdate(ctx context.Context, req *MappingAPIUpdateRequest) (*Response, error)

Update mapping API.

Update configuration of an existing mapping API.

API: POST /enrichment/mapping/api/update (mapping-api-write-update).

func (*AlertEnrichmentService) MappingDataReadDownload 

func (s *AlertEnrichmentService) MappingDataReadDownload(ctx context.Context, req *MappingSchemaIDRequest) (*Response, error)

Download mapping data as CSV.

Export all data rows of a mapping schema as a CSV file download.

The success body is a file, not a JSON envelope: it is returned on Response.Raw.

API: POST /enrichment/mapping/data/download (mapping-data-read-download).

func (*AlertEnrichmentService) MappingDataReadList 

func (s *AlertEnrichmentService) MappingDataReadList(ctx context.Context, req *MappingDataListRequest) (*MappingDataListResponse, *Response, error)

List mapping data.

Return paginated mapping data rows for a schema, with optional exact-match filtering on source label values.

API: POST /enrichment/mapping/data/list (mapping-data-read-list).

func (*AlertEnrichmentService) MappingDataWriteDelete 

func (s *AlertEnrichmentService) MappingDataWriteDelete(ctx context.Context, req *MappingDataDeleteRequest) (*Response, error)

Delete mapping data rows.

Delete up to 100 mapping data rows by their keys.

API: POST /enrichment/mapping/data/delete (mapping-data-write-delete).

func (*AlertEnrichmentService) MappingDataWriteTruncate 

func (s *AlertEnrichmentService) MappingDataWriteTruncate(ctx context.Context, req *MappingSchemaIDRequest) (*Response, error)

Truncate mapping data.

Delete all data rows in a mapping schema.

API: POST /enrichment/mapping/data/truncate (mapping-data-write-truncate).

func (*AlertEnrichmentService) MappingDataWriteUpload 

func (s *AlertEnrichmentService) MappingDataWriteUpload(ctx context.Context, req *MappingDataUploadRequest) (*Response, error)

MappingDataWriteUpload bulk-loads mapping data rows from a CSV file. By default the existing data is truncated before the new rows load; set DoNotTruncateFirst to append instead.

API: POST /enrichment/mapping/data/upload (mapping-data-write-upload).

func (*AlertEnrichmentService) MappingDataWriteUpsert 

func (s *AlertEnrichmentService) MappingDataWriteUpsert(ctx context.Context, req *MappingDataUpsertRequest) (*MappingDataUpsertResponse, *Response, error)

Upsert mapping data rows.

Insert or update up to 1000 data rows in a mapping schema. Each row must contain all source and result labels.

API: POST /enrichment/mapping/data/upsert (mapping-data-write-upsert).

func (*AlertEnrichmentService) MappingSchemaReadInfo 

func (s *AlertEnrichmentService) MappingSchemaReadInfo(ctx context.Context, req *MappingSchemaIDRequest) (*MappingSchemaItem, *Response, error)

Get mapping schema detail.

Return detail of a single mapping schema by its ID.

API: POST /enrichment/mapping/schema/info (mapping-schema-read-info).

func (*AlertEnrichmentService) MappingSchemaReadList 

func (s *AlertEnrichmentService) MappingSchemaReadList(ctx context.Context) (*MappingSchemaListResponse, *Response, error)

List mapping schemas.

Return all mapping schemas for the account, sorted by creation time ascending.

API: POST /enrichment/mapping/schema/list (mapping-schema-read-list).

func (*AlertEnrichmentService) MappingSchemaWriteCreate 

func (s *AlertEnrichmentService) MappingSchemaWriteCreate(ctx context.Context, req *MappingSchemaCreateRequest) (*MappingSchemaCreateResponse, *Response, error)

Create mapping schema.

Create a new mapping schema defining source lookup labels and the result labels to populate. Requires a Pro plan.

API: POST /enrichment/mapping/schema/create (mapping-schema-write-create).

func (*AlertEnrichmentService) MappingSchemaWriteDelete 

func (s *AlertEnrichmentService) MappingSchemaWriteDelete(ctx context.Context, req *MappingSchemaIDRequest) (*Response, error)

Delete mapping schema.

Delete a mapping schema and all its associated data. Deletion is blocked if the schema is referenced by any enrichment rule or webhook.

API: POST /enrichment/mapping/schema/delete (mapping-schema-write-delete).

func (*AlertEnrichmentService) MappingSchemaWriteUpdate 

func (s *AlertEnrichmentService) MappingSchemaWriteUpdate(ctx context.Context, req *MappingSchemaUpdateRequest) (*Response, error)

Update mapping schema.

Update the name, description, or owning team of a mapping schema. Source and result labels cannot be changed after creation.

API: POST /enrichment/mapping/schema/update (mapping-schema-write-update).

type AlertEventGlobalListRequest 

type AlertEventGlobalListRequest struct {
	ListOptions
	// Sort ascending when `true`.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by channel IDs. At most 100 entries.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// End of the search window, Unix epoch seconds. Must be greater than `start_time` when provided.
	EndTime *int64 `json:"end_time,omitempty" toon:"end_time,omitempty"`
	// Filter by integration IDs.
	IntegrationIDs []int64 `json:"integration_ids,omitempty" toon:"integration_ids,omitempty"`
	// Filter by integration types (plugin keys).
	IntegrationTypes []string `json:"integration_types,omitempty" toon:"integration_types,omitempty"`
	// Sort field; only `event_time` is supported.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Comma-separated severity filter, e.g. `Critical,Warning`. Accepted values: `Critical`, `Warning`, `Info`, `Ok`.
	Severities string `json:"severities,omitempty" toon:"severities,omitempty"`
	// Start of the search window, Unix epoch seconds. Must be greater than 0 when provided.
	StartTime *int64 `json:"start_time,omitempty" toon:"start_time,omitempty"`
}

AlertEventGlobalListRequest is generated from the Flashduty OpenAPI schema.

type AlertEventGlobalListResponse 

type AlertEventGlobalListResponse struct {
	// Whether a next page exists (probed by fetching limit+1 rows).
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Raw alert events on the current page.
	Items []AlertEventItem `json:"items" toon:"items"`
	// Cursor for the next page — the ObjectID of the last event on this page; pass it back as `search_after_ctx`. Omitted when the page is empty; in cursor mode also omitted when there is no next page.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total number of matching events, capped at 1000.
	Total int64 `json:"total" toon:"total"`
}

AlertEventGlobalListResponse is generated from the Flashduty OpenAPI schema.

type AlertEventItem 

type AlertEventItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Parent alert ID (MongoDB ObjectID).
	AlertID string `json:"alert_id" toon:"alert_id"`
	// Deduplication key used to merge events into an alert.
	AlertKey string `json:"alert_key" toon:"alert_key"`
	// Channel ID the event is routed to.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Record creation time, Unix epoch seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Deprecated. Use `integration_id` instead.
	DataSourceID int64 `json:"data_source_id" toon:"data_source_id"`
	// Soft-delete time, Unix epoch seconds. Omitted when the event is not deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Event description.
	Description string `json:"description" toon:"description"`
	// Event ID (MongoDB ObjectID).
	EventID string `json:"event_id" toon:"event_id"`
	// Severity of this event: `Critical`, `Warning`, or `Info`. An event never carries `Ok` as severity — `Ok` appears only as `event_status`.
	EventSeverity string `json:"event_severity" toon:"event_severity"`
	// Status carried by this event: `Critical`/`Warning`/`Info` for a firing event, `Ok` for a recovery event.
	EventStatus string `json:"event_status" toon:"event_status"`
	// Event timestamp, Unix epoch seconds.
	EventTime Timestamp `json:"event_time" toon:"event_time"`
	// Images attached to the event.
	Images []AlertImage `json:"images" toon:"images"`
	// Integration that produced this event.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Type/plugin key of the integration that produced this event.
	IntegrationType string `json:"integration_type" toon:"integration_type"`
	// Label key-value pairs.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Event title.
	Title string `json:"title" toon:"title"`
	// Title template used to derive `title` from labels.
	TitleRule string `json:"title_rule" toon:"title_rule"`
	// Record update time, Unix epoch seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

AlertEventItem is generated from the Flashduty OpenAPI schema.

type AlertEventListRequest 

type AlertEventListRequest struct {
	ListOptions
	// Alert ID (MongoDB ObjectID).
	AlertID string `json:"alert_id" toon:"alert_id"`
	// When true, return events oldest-first. Defaults to newest-first.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
}

AlertEventListRequest is generated from the Flashduty OpenAPI schema.

type AlertEventListResponse 

type AlertEventListResponse struct {
	// Whether another page is available.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Raw alert events in the requested order.
	Items []AlertEventItem `json:"items" toon:"items"`
	// Cursor to pass as `search_after_ctx` for the next page. Omitted when the page is empty; in cursor mode also omitted when there is no next page.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total matching event count, capped at 1000.
	Total int64 `json:"total" toon:"total"`
}

AlertEventListResponse is generated from the Flashduty OpenAPI schema.

type AlertFeedRequest 

type AlertFeedRequest struct {
	ListOptions
	// Alert ID (ObjectID hex string); obtain it from `POST /alert/list`.
	AlertID string `json:"alert_id" toon:"alert_id"`
	// Sort ascending.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by feed type codes — see the `type` field of the response items for the full list (e.g. `a_new`, `a_comm`, `a_merge`).
	Types []string `json:"types,omitempty" toon:"types,omitempty"`
}

AlertFeedRequest is generated from the Flashduty OpenAPI schema.

type AlertFeedResponse 

type AlertFeedResponse struct {
	// Whether a next page exists.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Alert feed records on the current page.
	Items []FeedItem `json:"items" toon:"items"`
}

AlertFeedResponse is generated from the Flashduty OpenAPI schema.

type AlertFeedType 

type AlertFeedType string

AlertFeedType Alert activity feed entry type. Each value identifies one alert lifecycle event; the matching `detail` payload shape is determined by this field. 

const (
	AlertFeedTypeANew       AlertFeedType = "a_new"
	AlertFeedTypeAUpdate    AlertFeedType = "a_update"
	AlertFeedTypeAComm      AlertFeedType = "a_comm"
	AlertFeedTypeAMerge     AlertFeedType = "a_merge"
	AlertFeedTypeAMSilence  AlertFeedType = "a_m_silence"
	AlertFeedTypeAMInhibit  AlertFeedType = "a_m_inhibit"
	AlertFeedTypeAMFlapping AlertFeedType = "a_m_flapping"
	AlertFeedTypeAAck       AlertFeedType = "a_ack"
	AlertFeedTypeAUnack     AlertFeedType = "a_unack"
	AlertFeedTypeAClose     AlertFeedType = "a_close"
)

func (AlertFeedType) String added in v0.5.2 

func (e AlertFeedType) String() string

String returns the underlying string value, implementing fmt.Stringer.

type AlertImage 

type AlertImage struct {
	// Alt text.
	Alt string `json:"alt" toon:"alt"`
	// Optional link URL when the image is clicked.
	Href string `json:"href" toon:"href"`
	// Image source URL or internal image reference (starts with `img_` or `http`).
	Src string `json:"src" toon:"src"`
}

AlertImage is generated from the Flashduty OpenAPI schema.

type AlertInfo 

type AlertInfo struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Alert ID (MongoDB ObjectID).
	AlertID string `json:"alert_id" toon:"alert_id"`
	// Deduplication key used to merge events into the alert.
	AlertKey string `json:"alert_key" toon:"alert_key"`
	// Current severity.
	AlertSeverity string `json:"alert_severity" toon:"alert_severity"`
	// Current status.
	AlertStatus string `json:"alert_status" toon:"alert_status"`
	// Channel ID.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel display name.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Channel status.
	ChannelStatus string `json:"channel_status" toon:"channel_status"`
	// Creation timestamp (seconds).
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Deprecated. Use `integration_id` instead.
	DataSourceID int64 `json:"data_source_id" toon:"data_source_id"`
	// Deprecated. Use `integration_name`.
	DataSourceName string `json:"data_source_name" toon:"data_source_name"`
	// Deprecated. Use `integration_ref_id`.
	DataSourceRefID string `json:"data_source_ref_id" toon:"data_source_ref_id"`
	// Deprecated. Use `integration_type`.
	DataSourceType string `json:"data_source_type" toon:"data_source_type"`
	// Soft-delete timestamp (seconds). Zero if not deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Alert description.
	Description string `json:"description" toon:"description"`
	// Unix timestamp (seconds) when the alert recovered. 0 if still active.
	EndTime Timestamp `json:"end_time" toon:"end_time"`
	// Total number of raw events merged into this alert.
	EventCnt int64 `json:"event_cnt" toon:"event_cnt"`
	// Raw alert event preview, populated only when requested. Capped at the 20 newest events per alert.
	Events []AlertEventItem `json:"events" toon:"events"`
	// Whether this alert has ever been silenced.
	EverMuted bool `json:"ever_muted" toon:"ever_muted"`
	// Attached images.
	Images []Image `json:"images" toon:"images"`
	// Parent incident reference, if the alert has been merged into one.
	Incident IncidentShort `json:"incident" toon:"incident"`
	// Integration ID that produced the alert.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Integration display name.
	IntegrationName string `json:"integration_name" toon:"integration_name"`
	// Integration reference ID.
	IntegrationRefID string `json:"integration_ref_id" toon:"integration_ref_id"`
	// Integration type string.
	IntegrationType string `json:"integration_type" toon:"integration_type"`
	// Alert labels.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Unix timestamp (seconds) of the most recent event.
	LastTime Timestamp `json:"last_time" toon:"last_time"`
	// Primary responder email, if any.
	ResponderEmail string `json:"responder_email" toon:"responder_email"`
	// Primary responder name, if any.
	ResponderName string `json:"responder_name" toon:"responder_name"`
	// Unix timestamp (seconds) when the alert first fired.
	StartTime Timestamp `json:"start_time" toon:"start_time"`
	// Alert title.
	Title string `json:"title" toon:"title"`
	// Title rendering rule.
	TitleRule string `json:"title_rule" toon:"title_rule"`
	// Last update timestamp (seconds).
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

AlertInfo is generated from the Flashduty OpenAPI schema.

type AlertInfoRequest 

type AlertInfoRequest struct {
	// Alert ID (ObjectID hex string).
	AlertID string `json:"alert_id" toon:"alert_id"`
}

AlertInfoRequest is generated from the Flashduty OpenAPI schema.

type AlertItem 

type AlertItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Unique alert ID (ObjectID hex string).
	AlertID string `json:"alert_id" toon:"alert_id"`
	// Deduplication key.
	AlertKey string `json:"alert_key" toon:"alert_key"`
	// Current severity — the highest severity ever seen on this alert: `Critical`, `Warning`, or `Info`.
	AlertSeverity string `json:"alert_severity" toon:"alert_severity"`
	// Current status: `Critical`/`Warning`/`Info` while firing, `Ok` once recovered.
	AlertStatus string `json:"alert_status" toon:"alert_status"`
	// ID of the channel the alert belongs to.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Display name of the channel.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Status of the channel: `enabled` or `disabled`.
	ChannelStatus string `json:"channel_status" toon:"channel_status"`
	// Creation timestamp, Unix epoch seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Deprecated: use `integration_id` instead.
	DataSourceID int64 `json:"data_source_id" toon:"data_source_id"`
	// Deprecated: use `integration_name` instead.
	DataSourceName string `json:"data_source_name" toon:"data_source_name"`
	// Deprecated: use `integration_ref_id` instead.
	DataSourceRefID string `json:"data_source_ref_id" toon:"data_source_ref_id"`
	// Deprecated: use `integration_type` instead. Omitted when empty.
	DataSourceType string `json:"data_source_type" toon:"data_source_type"`
	// Soft-delete time, Unix epoch seconds. Omitted when the alert is not deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Alert description.
	Description string `json:"description" toon:"description"`
	// Resolution time, Unix epoch seconds. 0 if still active.
	EndTime Timestamp `json:"end_time" toon:"end_time"`
	// Total number of raw events received by this alert.
	EventCnt int64 `json:"event_cnt" toon:"event_cnt"`
	// Raw events of this alert. Omitted here; populated only by `POST /incident/alert/list`.
	Events []AlertEventItem `json:"events" toon:"events"`
	// True if this alert has ever been silenced.
	EverMuted bool `json:"ever_muted" toon:"ever_muted"`
	// Images attached to the alert.
	Images []AlertImage `json:"images" toon:"images"`
	// Associated incident, if any.
	Incident IncidentShort `json:"incident" toon:"incident"`
	// ID of the integration that produced this alert.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Display name of the integration.
	IntegrationName string `json:"integration_name" toon:"integration_name"`
	// External reference ID of the integration.
	IntegrationRefID string `json:"integration_ref_id" toon:"integration_ref_id"`
	// Type/plugin key of the integration.
	IntegrationType string `json:"integration_type" toon:"integration_type"`
	// Label key-value pairs.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Last-event time, Unix epoch seconds.
	LastTime Timestamp `json:"last_time" toon:"last_time"`
	// Responder email. Always empty in this response — responder tracking lives on the associated incident.
	ResponderEmail string `json:"responder_email" toon:"responder_email"`
	// Responder display name. Always empty in this response — responder tracking lives on the associated incident.
	ResponderName string `json:"responder_name" toon:"responder_name"`
	// First-seen time, Unix epoch seconds.
	StartTime Timestamp `json:"start_time" toon:"start_time"`
	// Alert title.
	Title string `json:"title" toon:"title"`
	// Title template used to derive `title` from the event labels (e.g. `$service::$cluster`).
	TitleRule string `json:"title_rule" toon:"title_rule"`
	// Last update timestamp, Unix epoch seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

AlertItem is generated from the Flashduty OpenAPI schema.

type AlertListByIDsRequest 

type AlertListByIDsRequest struct {
	// Alert IDs (ObjectID hex strings) to fetch.
	AlertIDs []string `json:"alert_ids" toon:"alert_ids"`
}

AlertListByIDsRequest is generated from the Flashduty OpenAPI schema.

type AlertListRequest 

type AlertListRequest struct {
	ListOptions
	// Filter to specific alert IDs (ObjectID hex strings). Invalid IDs are ignored; if none are valid, the result is empty.
	AlertIDs []string `json:"alert_ids,omitempty" toon:"alert_ids,omitempty"`
	// Filter by alert deduplication keys.
	AlertKeys []string `json:"alert_keys,omitempty" toon:"alert_keys,omitempty"`
	// Comma-separated severity filter, e.g. `Critical,Warning`. Allowed values: `Critical`, `Warning`, `Info`, `Ok`.
	AlertSeverity string `json:"alert_severity,omitempty" toon:"alert_severity,omitempty"`
	// Sort ascending by `start_time` when `true`; default is descending.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// When `true`, the time range filter is applied on `updated_at` rather than `start_time`.
	ByUpdatedAt bool `json:"by_updated_at,omitempty" toon:"by_updated_at,omitempty"`
	// Filter by channel IDs.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// End of the search window, Unix epoch seconds. Must be greater than `start_time`; the span must not exceed 31 days and must lie within the account's data retention period.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// Filter by whether the alert has ever been silenced.
	EverMuted *bool `json:"ever_muted,omitempty" toon:"ever_muted,omitempty"`
	// Filter by integration IDs.
	IntegrationIDs []int64 `json:"integration_ids,omitempty" toon:"integration_ids,omitempty"`
	// Filter by lifecycle: `true` returns only firing alerts (status `Critical`/`Warning`/`Info`), `false` returns only recovered alerts (status `Ok`). Omit or pass `null` to return both.
	IsActive *bool `json:"is_active,omitempty" toon:"is_active,omitempty"`
	// Start of the search window, Unix epoch seconds.
	StartTime int64 `json:"start_time" toon:"start_time"`
}

AlertListRequest is generated from the Flashduty OpenAPI schema.

type AlertListResponse 

type AlertListResponse struct {
	// True if more pages are available.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Alerts on the current page.
	Items []AlertItem `json:"items" toon:"items"`
	// Cursor for the next page — the ObjectID hex of the last alert on this page; pass it back as `search_after_ctx`. Present only when `has_next_page` is true.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total matching alerts, capped at 1000.
	Total int64 `json:"total" toon:"total"`
}

AlertListResponse is generated from the Flashduty OpenAPI schema.

type AlertMergeRequest 

type AlertMergeRequest struct {
	// Alert IDs to merge (ObjectID hex strings); obtain them from `POST /alert/list`. Every ID must belong to the caller's account.
	AlertIDs []string `json:"alert_ids" toon:"alert_ids"`
	// Optional comment recorded on the merge feed entry. At most 1024 characters.
	Comment string `json:"comment,omitempty" toon:"comment,omitempty"`
	// Target incident ID (ObjectID hex string); obtain it from `POST /incident/list`.
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Member ID of the new owner for the target incident; obtain it from `POST /member/list`.
	OwnerID int64 `json:"owner_id,omitempty" toon:"owner_id,omitempty"`
	// Optional new title for the target incident. At most 512 characters.
	Title string `json:"title,omitempty" toon:"title,omitempty"`
}

AlertMergeRequest is generated from the Flashduty OpenAPI schema.

type AlertPipeline 

type AlertPipeline struct {
	// AND-filter list — the rule applies only when every condition matches. `null` or omitted means the rule applies to all events.
	If []FilterCondition `json:"if,omitempty" toon:"if,omitempty"`
	// Rule type. Rules run in array order; when the `if` condition matches, the event is processed according to `kind`.
	// | Value | Meaning |
	// |---|---|
	// | `title_reset` | Rewrites the event title from the `settings.title` template. |
	// | `description_reset` | Rewrites the event description from the `settings.description` template. |
	// | `severity_reset` | Resets the event severity and status to `settings.severity` (`Critical`/`Warning`/`Info`). |
	// | `alert_drop` | Discards the matching event outright; no alert is created. |
	// | `alert_inhibit` | Discards the event (inhibition) when an active source alert matching `settings.source_filters` and correlated via `settings.equals` exists. |
	Kind string `json:"kind" toon:"kind"`
	// Kind-specific settings. Shape depends on `kind`:
	// - `title_reset`: `{ "title": "<string>" }`
	// - `description_reset`: `{ "description": "<string>" }`
	// - `severity_reset`: `{ "severity": "Critical"|"Warning"|"Info" }`
	// - `alert_drop`: `{}` (empty object)
	// - `alert_inhibit`: `{ "equals": ["<label_key>", ...], "source_filters": <OrFilterGroup> }`
	Settings any `json:"settings,omitempty" toon:"settings,omitempty"`
}

AlertPipeline is generated from the Flashduty OpenAPI schema.

type AlertPipelineInfoRequest 

type AlertPipelineInfoRequest struct {
	// Integration ID. Must be greater than 0.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
}

AlertPipelineInfoRequest is generated from the Flashduty OpenAPI schema.

type AlertPipelineItem 

type AlertPipelineItem struct {
	// Creation timestamp, Unix epoch seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Member ID who created the pipeline.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Soft-delete time, Unix epoch seconds. Omitted when not deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Integration ID this pipeline applies to.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Ordered list of processing rules.
	Rules []AlertPipeline `json:"rules" toon:"rules"`
	// Pipeline status. Always `enabled` in these responses — deleted pipelines are filtered out.
	Status string `json:"status" toon:"status"`
	// Last update timestamp, Unix epoch seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Member ID who last updated the pipeline.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

AlertPipelineItem is generated from the Flashduty OpenAPI schema.

type AlertPipelineListRequest 

type AlertPipelineListRequest struct {
	// Integration IDs. At least one entry is required.
	IntegrationIDs []int64 `json:"integration_ids" toon:"integration_ids"`
}

AlertPipelineListRequest is generated from the Flashduty OpenAPI schema.

type AlertPipelineListResponse 

type AlertPipelineListResponse struct {
	// Alert pipeline configuration of each requested integration, one item per configured integration.
	Items []AlertPipelineItem `json:"items" toon:"items"`
}

AlertPipelineListResponse is generated from the Flashduty OpenAPI schema.

type AlertPipelineUpsertRequest 

type AlertPipelineUpsertRequest struct {
	// Integration ID to configure.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Rules to apply, evaluated in array order. Between 1 and 50 entries.
	Rules []AlertPipeline `json:"rules" toon:"rules"`
}

AlertPipelineUpsertRequest is generated from the Flashduty OpenAPI schema.

type AlertRule 

type AlertRule struct {
	// Account ID. Filled by the server from the authenticated identity; do not provide.
	AccountID uint64 `json:"account_id,omitempty" toon:"account_id,omitempty"`
	// Annotation key-value pairs delivered with alert events; keys must not start with `$` (reserved for query fields).
	Annotations map[string]string `json:"annotations,omitempty" toon:"annotations,omitempty"`
	// Channel IDs to send alerts to.
	ChannelIDs []uint64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Creation time as a Unix timestamp in seconds. Generated by the server; do not provide.
	CreatedAt int64 `json:"created_at,omitempty" toon:"created_at,omitempty"`
	// Creator user ID. Filled by the server from the current user; do not provide.
	CreatorID uint64 `json:"creator_id,omitempty" toon:"creator_id,omitempty"`
	// Creator name. Filled by the server; do not provide.
	CreatorName string `json:"creator_name,omitempty" toon:"creator_name,omitempty"`
	// Schedule expression: a 6-field cron (with seconds) or an `@every 30s` interval descriptor. Must not start with `CRON_TZ=` or `TZ=`; use the `timezone` field instead.
	CronPattern string `json:"cron_pattern" toon:"cron_pattern"`
	// Whether to enable debug logging; the edge emits detailed evaluation logs, useful for troubleshooting rules that do not trigger as expected.
	DebugLogEnabled bool `json:"debug_log_enabled,omitempty" toon:"debug_log_enabled,omitempty"`
	// Seconds to shift the evaluation query window backward, compensating for data ingestion latency.
	DelaySeconds int64 `json:"delay_seconds,omitempty" toon:"delay_seconds,omitempty"`
	// Rule description, in Markdown.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Format for the description. Defaults to `text` when omitted or empty. `text` = plain text; `markdown` = Markdown, rendered as Markdown in alert details.
	DescriptionType string `json:"description_type,omitempty" toon:"description_type,omitempty"`
	// Datasource IDs, merged with `ds_list` to decide which datasources the rule monitors; IDs survive datasource renames. At least one of `ds_list` and `ds_ids` must be provided.
	DsIDs []uint64 `json:"ds_ids,omitempty" toon:"ds_ids,omitempty"`
	// Data source name patterns (supports wildcards). At least one of `ds_list` / `ds_ids` must be non-empty; the two are merged to decide which datasources the rule monitors.
	DsList []string `json:"ds_list,omitempty" toon:"ds_list,omitempty"`
	// Datasource type identifier; allowed values are listed by `POST /monit/rule/dstypes` (e.g. `prometheus`, `elasticsearch`).
	DsType string `json:"ds_type" toon:"ds_type"`
	// Whether the rule is enabled. Updating to `false` makes the server clean up the rule's active alerts.
	Enabled bool `json:"enabled,omitempty" toon:"enabled,omitempty"`
	// Time windows when the rule is active. Defaults to all days from 00:00 to 23:59 when omitted or empty.
	EnabledTimes []AlertRuleEnabledTimesItem `json:"enabled_times,omitempty" toon:"enabled_times,omitempty"`
	// ID of the folder the rule belongs to. Obtainable via `POST /monit/folder/list`.
	FolderID uint64 `json:"folder_id" toon:"folder_id"`
	// Rule ID. Required for update; omit for create (assigned by the server).
	ID uint64 `json:"id,omitempty" toon:"id,omitempty"`
	// Custom labels.
	Labels map[string]string `json:"labels,omitempty" toon:"labels,omitempty"`
	// Rule name. Must be unique within the same folder.
	Name string `json:"name" toon:"name"`
	// Notification repeat interval in seconds.
	RepeatInterval int64 `json:"repeat_interval,omitempty" toon:"repeat_interval,omitempty"`
	// Max number of repeat notifications.
	RepeatTotal int64 `json:"repeat_total,omitempty" toon:"repeat_total,omitempty"`
	// Check configuration: query list plus trigger/recovery conditions. Structure see `RuleConfigs`.
	RuleConfigs RuleConfigs `json:"rule_configs" toon:"rule_configs"`
	// Timezone in which the rule executes. Determines how the cron schedule and effective time windows are interpreted. Only IANA timezone names are accepted (e.g. `Asia/Shanghai`, `UTC`, `Europe/London`); shortcuts and offsets such as `Local`, `UTC+8`, or `CST` are rejected. Treated as `Asia/Shanghai` if empty.
	Timezone string `json:"timezone,omitempty" toon:"timezone,omitempty"`
	// Last update time as a Unix timestamp in seconds. Generated by the server; do not provide.
	UpdatedAt int64 `json:"updated_at,omitempty" toon:"updated_at,omitempty"`
	// Last updater user ID. Filled by the server; do not provide.
	UpdaterID uint64 `json:"updater_id,omitempty" toon:"updater_id,omitempty"`
	// Last updater name. Filled by the server; do not provide.
	UpdaterName string `json:"updater_name,omitempty" toon:"updater_name,omitempty"`
}

AlertRule is generated from the Flashduty OpenAPI schema.

type AlertRuleAudit 

type AlertRuleAudit struct {
	// ID of the account that owns the rule.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Action performed: `create` = rule created; `update` = rule updated (covers full updates, field-batch updates, imports and moves).
	Action string `json:"action" toon:"action"`
	// ID of the alert rule this record belongs to.
	AlertRuleID uint64 `json:"alert_rule_id" toon:"alert_rule_id"`
	// JSON string of the full rule snapshot at audit time. Populated on `/monit/rule/audit/detail`, omitted on list responses.
	Content string `json:"content" toon:"content"`
	// When this audit record was produced, as a Unix timestamp in seconds; equals the rule's `updated_at` at change time.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// ID of the user who made this change (taken from the rule's `updater_id` at change time).
	CreatorID uint64 `json:"creator_id" toon:"creator_id"`
	// Name of the user who made this change (taken from the rule's `updater_name` at change time).
	CreatorName string `json:"creator_name" toon:"creator_name"`
	// Audit record ID.
	ID uint64 `json:"id" toon:"id"`
}

AlertRuleAudit is generated from the Flashduty OpenAPI schema.

type AlertRuleBasic 

type AlertRuleBasic struct {
	// Account ID.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Number of currently active (unrecovered) alerts fired by this rule. `triggered` equals `active_alert_count > 0`.
	ActiveAlertCount int64 `json:"active_alert_count" toon:"active_alert_count"`
	// Creation time, as a Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// ID of the user who created the rule.
	CreatorID uint64 `json:"creator_id" toon:"creator_id"`
	// Name of the user who created the rule.
	CreatorName string `json:"creator_name" toon:"creator_name"`
	// Schedule expression: a 6-field cron with seconds, e.g. `0 * * * * *`, or an `@every 30s` interval descriptor. Must not start with `CRON_TZ=` or `TZ=`; use the `timezone` field instead.
	CronPattern string `json:"cron_pattern" toon:"cron_pattern"`
	// Whether debug logging is enabled.
	DebugLogEnabled bool `json:"debug_log_enabled" toon:"debug_log_enabled"`
	// Evaluation delay in seconds.
	DelaySeconds int64 `json:"delay_seconds" toon:"delay_seconds"`
	// Data source type, e.g. `prometheus`.
	DsType string `json:"ds_type" toon:"ds_type"`
	// Whether the rule is enabled.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Folder ID.
	FolderID uint64 `json:"folder_id" toon:"folder_id"`
	// Unique rule ID.
	ID uint64 `json:"id" toon:"id"`
	// Custom labels.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Rule name.
	Name string `json:"name" toon:"name"`
	// Runtime evaluation state, derived from edge heartbeats and the edge-reported rule status. Omitted when the state is unavailable.
	//
	// | Value | Meaning |
	// |---|---|
	// | `disabled` | The rule is disabled. |
	// | `offline` | The edge instance or cluster owning this rule is offline. |
	// | `abnormal` | The edge reports evaluation errors. |
	// | `stale` | The edge's runtime status report is outdated. |
	// | `no_datasource` | No datasource currently matches the rule's `ds_list` / `ds_ids`. |
	// | `config_pending` | The latest rule config has not been delivered to the edge yet. |
	// | `waiting` | Enabled, but the edge has not reported runtime status yet. |
	// | `normal` | Evaluating normally. |
	RuntimeState string `json:"runtime_state" toon:"runtime_state"`
	// Timezone in which the rule executes. Determines how the cron schedule and effective time windows are interpreted. Only IANA timezone names are accepted (e.g. `Asia/Shanghai`, `UTC`, `Europe/London`); shortcuts and offsets such as `Local`, `UTC+8`, or `CST` are rejected. Treated as `Asia/Shanghai` if empty.
	Timezone string `json:"timezone" toon:"timezone"`
	// True if the rule currently has active alerts.
	Triggered bool `json:"triggered" toon:"triggered"`
	// Last modification time, as a Unix timestamp in seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// ID of the user who last modified the rule.
	UpdaterID uint64 `json:"updater_id" toon:"updater_id"`
	// Name of the user who last modified the rule.
	UpdaterName string `json:"updater_name" toon:"updater_name"`
}

AlertRuleBasic is generated from the Flashduty OpenAPI schema.

type AlertRuleCounter 

type AlertRuleCounter struct {
	// ID of the account this snapshot belongs to.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Sample timestamp, Unix epoch seconds.
	Clock Timestamp `json:"clock" toon:"clock"`
	// ID of this snapshot record.
	ID uint64 `json:"id" toon:"id"`
	// Rule count at the sample time.
	Num int64 `json:"num" toon:"num"`
}

AlertRuleCounter is generated from the Flashduty OpenAPI schema.

type AlertRuleEnabledTimesItem 

type AlertRuleEnabledTimesItem struct {
	// Days of week (0=Sunday).
	Days []int64 `json:"days,omitempty" toon:"days,omitempty"`
	// End time, e.g. `18:00`.
	Etime string `json:"etime,omitempty" toon:"etime,omitempty"`
	// Start time, e.g. `09:00`.
	Stime string `json:"stime,omitempty" toon:"stime,omitempty"`
}

AlertRuleEnabledTimesItem is generated from the Flashduty OpenAPI schema.

type AlertRuleExport 

type AlertRuleExport struct {
	// Custom annotation key-value pairs attached to alert events; keys must not start with `$` (reserved for query field references).
	Annotations map[string]string `json:"annotations" toon:"annotations"`
	// Evaluation schedule as a 6-field cron expression (seconds included) or `@every <duration>` (an integral number of seconds, at least 1s); `CRON_TZ=`/`TZ=` prefixes are rejected — set the timezone in `timezone` instead.
	CronPattern string `json:"cron_pattern" toon:"cron_pattern"`
	// Whether to emit debug logs for this rule's evaluations; enable when troubleshooting.
	DebugLogEnabled bool `json:"debug_log_enabled" toon:"debug_log_enabled"`
	// Query time offset in seconds: each evaluation reads data as of `schedule time − delay_seconds` to tolerate ingestion lag; `0` means no offset.
	DelaySeconds int64 `json:"delay_seconds" toon:"delay_seconds"`
	// Rule description in the format given by `description_type`, shown with alert events.
	Description string `json:"description" toon:"description"`
	// Format of `description`, `text` or `markdown`; treated as `text` when omitted.
	DescriptionType string `json:"description_type" toon:"description_type"`
	// Datasource ID list, merged with `ds_list`; references by ID and is therefore immune to datasource renames.
	DsIDs []uint64 `json:"ds_ids" toon:"ds_ids"`
	// Datasource name list with wildcard support; merged with `ds_ids` to decide which datasources the rule monitors — must be maintained by hand if a datasource is renamed.
	DsList []string `json:"ds_list" toon:"ds_list"`
	// Datasource type ident, e.g. `prometheus`; must be a datasource type (`ident`) that exists in the import target environment.
	DsType string `json:"ds_type" toon:"ds_type"`
	// Whether the rule is enabled; rules imported as disabled are not evaluated.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Effective time windows; each entry has `days` (0–6, 0 = Sunday) and `stime`/`etime` (`HH:MM`), interpreted in the rule's `timezone`; an empty list disables the rule.
	EnabledTimes []EnabledTime `json:"enabled_times" toon:"enabled_times"`
	// Custom label key-value pairs attached to alert events produced by this rule.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Rule name, up to 128 characters when imported.
	Name string `json:"name" toon:"name"`
	// Interval in seconds between repeated notifications for a firing alert; values below 1 fall back to the default of 3600.
	RepeatInterval int64 `json:"repeat_interval" toon:"repeat_interval"`
	// Maximum number of repeated notifications for the same alert; values below 1 fall back to the default of 3.
	RepeatTotal int64       `json:"repeat_total" toon:"repeat_total"`
	RuleConfigs RuleConfigs `json:"rule_configs" toon:"rule_configs"`
	// Timezone in which the rule executes. IANA timezone name; defaults to `Asia/Shanghai`.
	Timezone string `json:"timezone" toon:"timezone"`
}

AlertRuleExport is generated from the Flashduty OpenAPI schema.

type AlertRuleExportListResponse 

type AlertRuleExportListResponse []AlertRuleExport

AlertRuleExportListResponse is a list response payload.

type AlertRuleInfoResponse 

type AlertRuleInfoResponse struct {
	// Account ID. Filled by the server from the authenticated identity; do not provide.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Annotation key-value pairs delivered with alert events; keys must not start with `$` (reserved for query fields).
	Annotations map[string]string `json:"annotations" toon:"annotations"`
	// Channel IDs to send alerts to.
	ChannelIDs []uint64 `json:"channel_ids" toon:"channel_ids"`
	// Creation time as a Unix timestamp in seconds. Generated by the server; do not provide.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Creator user ID. Filled by the server from the current user; do not provide.
	CreatorID uint64 `json:"creator_id" toon:"creator_id"`
	// Creator name. Filled by the server; do not provide.
	CreatorName string `json:"creator_name" toon:"creator_name"`
	// Schedule expression: a 6-field cron (with seconds) or an `@every 30s` interval descriptor. Must not start with `CRON_TZ=` or `TZ=`; use the `timezone` field instead.
	CronPattern string `json:"cron_pattern" toon:"cron_pattern"`
	// Whether to enable debug logging; the edge emits detailed evaluation logs, useful for troubleshooting rules that do not trigger as expected.
	DebugLogEnabled bool `json:"debug_log_enabled" toon:"debug_log_enabled"`
	// Seconds to shift the evaluation query window backward, compensating for data ingestion latency.
	DelaySeconds int64 `json:"delay_seconds" toon:"delay_seconds"`
	// Rule description, in Markdown.
	Description string `json:"description" toon:"description"`
	// Format for the description. Defaults to `text` when omitted or empty. `text` = plain text; `markdown` = Markdown, rendered as Markdown in alert details.
	DescriptionType string `json:"description_type" toon:"description_type"`
	// Datasource IDs, merged with `ds_list` to decide which datasources the rule monitors; IDs survive datasource renames. At least one of `ds_list` and `ds_ids` must be provided.
	DsIDs []uint64 `json:"ds_ids" toon:"ds_ids"`
	// Data source name patterns (supports wildcards). At least one of `ds_list` / `ds_ids` must be non-empty; the two are merged to decide which datasources the rule monitors.
	DsList []string `json:"ds_list" toon:"ds_list"`
	// Datasource type identifier; allowed values are listed by `POST /monit/rule/dstypes` (e.g. `prometheus`, `elasticsearch`).
	DsType string `json:"ds_type" toon:"ds_type"`
	// Whether the rule is enabled. Updating to `false` makes the server clean up the rule's active alerts.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Time windows when the rule is active. Defaults to all days from 00:00 to 23:59 when omitted or empty.
	EnabledTimes []AlertRuleInfoResponseEnabledTimesItem `json:"enabled_times" toon:"enabled_times"`
	// ID of the folder the rule belongs to. Obtainable via `POST /monit/folder/list`.
	FolderID uint64 `json:"folder_id" toon:"folder_id"`
	// Rule ID. Required for update; omit for create (assigned by the server).
	ID uint64 `json:"id" toon:"id"`
	// Custom labels.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Rule name. Must be unique within the same folder.
	Name string `json:"name" toon:"name"`
	// Notification repeat interval in seconds.
	RepeatInterval int64 `json:"repeat_interval" toon:"repeat_interval"`
	// Max number of repeat notifications.
	RepeatTotal int64 `json:"repeat_total" toon:"repeat_total"`
	// Check configuration: query list plus trigger/recovery conditions. Structure see `RuleConfigs`.
	RuleConfigs RuleConfigs `json:"rule_configs" toon:"rule_configs"`
	// Timezone in which the rule executes. Determines how the cron schedule and effective time windows are interpreted. Only IANA timezone names are accepted (e.g. `Asia/Shanghai`, `UTC`, `Europe/London`); shortcuts and offsets such as `Local`, `UTC+8`, or `CST` are rejected. Treated as `Asia/Shanghai` if empty.
	Timezone string `json:"timezone" toon:"timezone"`
	// Last update time as a Unix timestamp in seconds. Generated by the server; do not provide.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Last updater user ID. Filled by the server; do not provide.
	UpdaterID uint64 `json:"updater_id" toon:"updater_id"`
	// Last updater name. Filled by the server; do not provide.
	UpdaterName string `json:"updater_name" toon:"updater_name"`
}

AlertRuleInfoResponse is generated from the Flashduty OpenAPI schema.

type AlertRuleInfoResponseEnabledTimesItem 

type AlertRuleInfoResponseEnabledTimesItem struct {
	// Days of week (0=Sunday).
	Days []int64 `json:"days" toon:"days"`
	// End time, e.g. `18:00`.
	Etime string `json:"etime" toon:"etime"`
	// Start time, e.g. `09:00`.
	Stime string `json:"stime" toon:"stime"`
}

AlertRuleInfoResponseEnabledTimesItem is generated from the Flashduty OpenAPI schema.

type AlertRuleStatus 

type AlertRuleStatus struct {
	// ID of the folder (grouping node).
	FolderID uint64 `json:"folder_id" toon:"folder_id"`
	// Folder name; omitted by some endpoints (`omitempty`).
	FolderName string `json:"folder_name" toon:"folder_name"`
	// Total rules in the folder family.
	RuleTotal int64 `json:"rule_total" toon:"rule_total"`
	// Rules with active alerts.
	TriggeredRuleCount int64 `json:"triggered_rule_count" toon:"triggered_rule_count"`
}

AlertRuleStatus is generated from the Flashduty OpenAPI schema.

type AlertRulesService 

type AlertRulesService service

AlertRulesService handles the "Monitors/Alert rules" API resource.

func (*AlertRulesService) ReadAuditDetail 

func (s *AlertRulesService) ReadAuditDetail(ctx context.Context, req *AuditRecordIDRequest) (*AlertRuleAudit, *Response, error)

Get rule audit snapshot.

Return the audit record (including the `content` field, a JSON string of the rule snapshot at that point in time).

API: POST /monit/rule/audit/detail (monit-rule-read-audit-detail).

func (*AlertRulesService) ReadAudits 

func (s *AlertRulesService) ReadAudits(ctx context.Context, req *RuleIDRequest) (*RuleAuditListResponse, *Response, error)

List rule change history.

Return the change history (audit records) for an alert rule.

API: POST /monit/rule/audits (monit-rule-read-audits).

func (*AlertRulesService) ReadCounterChannel 

func (s *AlertRulesService) ReadCounterChannel(ctx context.Context) (*RuleCounterChannelResponse, *Response, error)

Get rule counts by channel.

Return an object mapping channel name to the number of rules routing alerts to that channel. If a channel name cannot be resolved, the channel ID (as a string) is used as the key.

API: POST /monit/rule/counter/channel (monit-rule-read-counter-channel).

func (*AlertRulesService) ReadCounterNode 

func (s *AlertRulesService) ReadCounterNode(ctx context.Context) (*RuleCounterNodeResponse, *Response, error)

Get rule counts by folder node.

Return an object mapping top-level folder name to the total number of rules under that folder and all its descendants.

API: POST /monit/rule/counter/node (monit-rule-read-counter-node).

func (*AlertRulesService) ReadCounterStatus 

func (s *AlertRulesService) ReadCounterStatus(ctx context.Context) (*RuleStatusResponse, *Response, error)

Get rule status counters for top-level folders.

Return trigger status summary for all top-level folder nodes — used for the overview dashboard.

API: POST /monit/rule/counter/status (monit-rule-read-counter-status).

func (*AlertRulesService) ReadCounterTotal 

func (s *AlertRulesService) ReadCounterTotal(ctx context.Context) (*RuleCounterTotalResponse, *Response, error)

Get rule counter time series.

Return the stored time series of the total rule count across the account — one sample per `clock` timestamp.

API: POST /monit/rule/counter/total (monit-rule-read-counter-total).

func (*AlertRulesService) ReadDstypes 

func (s *AlertRulesService) ReadDstypes(ctx context.Context) (*RuleDsTypesResponse, *Response, error)

List available datasource types.

Return the list of datasource types (`DSType` records) that the current account can use when authoring alert rules — combines global types and account-scoped types.

API: POST /monit/rule/dstypes (monit-rule-read-dstypes).

func (*AlertRulesService) ReadExport 

func (s *AlertRulesService) ReadExport(ctx context.Context, req *RuleIDsRequest) (*AlertRuleExportListResponse, *Response, error)

Export alert rules.

Export the configuration of selected alert rules as a portable JSON array, compatible with `POST /monit/rule/import`.

API: POST /monit/rule/export (monit-rule-read-export).

func (*AlertRulesService) ReadInfo 

func (s *AlertRulesService) ReadInfo(ctx context.Context, req *RuleIDRequest) (*AlertRuleInfoResponse, *Response, error)

Get alert rule detail.

Return the full configuration of an alert rule by its ID, including rule queries, thresholds, and notification settings.

API: POST /monit/rule/info (monit-rule-read-info).

func (*AlertRulesService) ReadList 

func (s *AlertRulesService) ReadList(ctx context.Context, req *RuleListRequest) (*RuleBasicListResponse, *Response, error)

List alert rules.

Return the basic information of all alert rules in a folder. For full rule details, call `POST /monit/rule/info`.

API: POST /monit/rule/list/basic (monit-rule-read-list).

func (*AlertRulesService) WriteCreate 

func (s *AlertRulesService) WriteCreate(ctx context.Context, req *AlertRule) (*AlertRule, *Response, error)

Create alert rule.

Create a new alert rule. Returns the created rule with its assigned ID.

API: POST /monit/rule/create (monit-rule-write-create).

func (*AlertRulesService) WriteDelete 

func (s *AlertRulesService) WriteDelete(ctx context.Context, req *RuleIDRequest) (*Response, error)

Delete alert rule.

Delete a single alert rule by its ID.

API: POST /monit/rule/delete (monit-rule-write-delete).

func (*AlertRulesService) WriteDeleteBatch 

func (s *AlertRulesService) WriteDeleteBatch(ctx context.Context, req *RuleIDsRequest) (*Response, error)

Batch delete alert rules.

Delete multiple alert rules in a single request.

API: POST /monit/rule/delete/batch (monit-rule-write-delete-batch).

func (*AlertRulesService) WriteFieldsUpdate 

func (s *AlertRulesService) WriteFieldsUpdate(ctx context.Context, req *RuleFieldsUpdateRequest) (*RuleNameMessageListResponse, *Response, error)

Batch update rule fields.

Update specific fields across multiple alert rules at once. Only the fields listed in `fields` are applied.

API: POST /monit/rule/update/fields (monit-rule-write-fields-update).

func (*AlertRulesService) WriteImport 

func (s *AlertRulesService) WriteImport(ctx context.Context, req *RuleImportRequest) (*RuleImportResponse, *Response, error)

Import alert rules.

Import one or more alert rules from a JSON array. Returns the result for each rule, indicating success or failure.

API: POST /monit/rule/import (monit-rule-write-import).

func (*AlertRulesService) WriteMove 

func (s *AlertRulesService) WriteMove(ctx context.Context, req *RuleMoveRequest) (*RuleNameMessageListResponse, *Response, error)

Move alert rules to folder.

Move one or more alert rules to a different folder.

API: POST /monit/rule/move (monit-rule-write-move).

func (*AlertRulesService) WriteUpdate 

func (s *AlertRulesService) WriteUpdate(ctx context.Context, req *AlertRule) (*AlertRule, *Response, error)

Update alert rule.

Replace the full configuration of an existing alert rule. All fields are overwritten.

API: POST /monit/rule/update (monit-rule-write-update).

type AlertShort added in v0.14.3 

type AlertShort struct {
	// Alert ID (ObjectID hex string).
	AlertID string `json:"alert_id" toon:"alert_id"`
	// Alert title, resolved at read time. Omitted when empty.
	Title string `json:"title" toon:"title"`
}

AlertShort is generated from the Flashduty OpenAPI schema.

type AlertsService 

type AlertsService service

AlertsService handles the "On-call/Alerts" API resource.

func (*AlertsService) EventReadList 

func (s *AlertsService) EventReadList(ctx context.Context, req *AlertEventGlobalListRequest) (*AlertEventGlobalListResponse, *Response, error)

List raw alert events.

Return a cursor-paginated list of raw alert events across all alerts, with filtering by integration, channel, time range, and severity.

API: POST /alert-event/list (alert-event-read-list).

func (*AlertsService) ReadEventList 

func (s *AlertsService) ReadEventList(ctx context.Context, req *AlertEventListRequest) (*AlertEventListResponse, *Response, error)

List events for an alert.

Return raw events for an alert with cursor or page-number pagination.

API: POST /alert/event/list (alert-read-event-list).

func (*AlertsService) ReadFeed 

func (s *AlertsService) ReadFeed(ctx context.Context, req *AlertFeedRequest) (*AlertFeedResponse, *Response, error)

List alert activity feed.

Return the activity feed (comments, state changes, merges, silence events) for a single alert, with page-based pagination.

API: POST /alert/feed (alert-read-feed).

func (*AlertsService) ReadInfo 

func (s *AlertsService) ReadInfo(ctx context.Context, req *AlertInfoRequest) (*AlertItem, *Response, error)

Get alert detail.

Return the full details of a single alert by its ID, including its associated incident and event count.

API: POST /alert/info (alert-read-info).

func (*AlertsService) ReadList 

func (s *AlertsService) ReadList(ctx context.Context, req *AlertListRequest) (*AlertListResponse, *Response, error)

List alerts.

Return a cursor-paginated list of alerts matching the given filters.

API: POST /alert/list (alert-read-list).

func (*AlertsService) ReadListByIDs 

func (s *AlertsService) ReadListByIDs(ctx context.Context, req *AlertListByIDsRequest) (*AlertListResponse, *Response, error)

List alerts by IDs.

Return the details of multiple alerts by their IDs in a single request. Note: this endpoint does not paginate — `total` and `has_next_page` are always `0`/`false` and `search_after_ctx` is never set.

API: POST /alert/list-by-ids (alert-read-list-by-ids).

func (*AlertsService) ReadPipelineInfo 

func (s *AlertsService) ReadPipelineInfo(ctx context.Context, req *AlertPipelineInfoRequest) (*AlertPipelineItem, *Response, error)

Get alert pipeline.

Return the alert processing pipeline configured for a specific integration.

API: POST /alert/pipeline/info (alert-read-pipeline-info).

func (*AlertsService) ReadPipelineList 

func (s *AlertsService) ReadPipelineList(ctx context.Context, req *AlertPipelineListRequest) (*AlertPipelineListResponse, *Response, error)

List alert pipelines.

Return the alert processing pipelines configured for multiple integrations.

API: POST /alert/pipeline/list (alert-read-pipeline-list).

func (*AlertsService) WriteMerge 

func (s *AlertsService) WriteMerge(ctx context.Context, req *AlertMergeRequest) (*Response, error)

Merge alerts into an incident.

Associate one or more alerts with an existing incident. If a source alert previously belonged to a different incident and that incident becomes empty after the merge, it will be automatically closed.

API: POST /alert/merge (alert-write-merge).

func (*AlertsService) WritePipelineUpsert 

func (s *AlertsService) WritePipelineUpsert(ctx context.Context, req *AlertPipelineUpsertRequest) (*Response, error)

Create or update alert pipeline.

Set the alert processing pipeline for an integration. Replaces the existing configuration entirely.

API: POST /alert/pipeline/upsert (alert-write-pipeline-upsert).

type AnalyticsService 

type AnalyticsService service

AnalyticsService handles the "On-call/Analytics" API resource.

func (*AnalyticsService) ByAccount 

func (s *AnalyticsService) ByAccount(ctx context.Context, req *InsightQueryRequest) (*DimensionInsightResponse, *Response, error)

Get account-level insight.

Return aggregated incident insight metrics for the entire account.

API: POST /insight/account (insightByAccount).

func (*AnalyticsService) ByChannel 

func (s *AnalyticsService) ByChannel(ctx context.Context, req *InsightQueryRequest) (*DimensionInsightResponse, *Response, error)

Get channel insight.

Return insight metrics aggregated by channel.

API: POST /insight/channel (insightByChannel).

func (*AnalyticsService) ByResponder 

func (s *AnalyticsService) ByResponder(ctx context.Context, req *InsightQueryRequest) (*ResponderInsightResponse, *Response, error)

Get responder insight.

Return insight metrics aggregated by responder.

API: POST /insight/responder (insightByResponder).

func (*AnalyticsService) ByTeam 

func (s *AnalyticsService) ByTeam(ctx context.Context, req *InsightQueryRequest) (*DimensionInsightResponse, *Response, error)

Get team insight.

Return insight metrics aggregated by team.

API: POST /insight/team (insightByTeam).

func (*AnalyticsService) ChannelExport 

func (s *AnalyticsService) ChannelExport(ctx context.Context, req *InsightQueryRequest) (*Response, error)

Export channel insight.

Export channel insight metrics as a CSV file — one row per channel (and per time/hour bucket when `aggregate_unit`/`split_hours` is used). The response is a CSV stream delivered with `Content-Disposition: attachment` — it is not a JSON envelope. `time_zone` defaults to UTC. Rows without a valid channel ID are skipped. Valid `export_fields` keys: channel_id, channel_name, total_incident_cnt, total_incidents_acknowledged, total_incidents_closed, total_incidents_auto_closed, total_incidents_manually_closed, total_incidents_timeout_closed, total_incidents_escalated, total_incidents_manually_escalated, total_incidents_timeout_escalated, total_incidents_reassigned, total_interruptions, total_notifications, total_engaged_seconds, mean_seconds_to_ack, mean_seconds_to_close, noise_reduction_pct, acknowledgement_pct, total_alert_cnt, total_alert_event_cnt, hours. The `hours` column is included by default only when `split_hours` is true. For compatibility, incident-export column keys are also accepted but produce empty columns.

The success body is a file, not a JSON envelope: it is returned on Response.Raw.

API: POST /insight/channel/export (insightChannelExport).

func (*AnalyticsService) IncidentExport 

func (s *AnalyticsService) IncidentExport(ctx context.Context, req *InsightIncidentExportRequest) (*Response, error)

Export insight incidents.

Export the filtered incident analytics list as a CSV file. The response is a CSV stream delivered with `Content-Disposition: attachment` — it is not a JSON envelope. CSV headers and formatted values use the request locale, falling back to the member locale and then the account locale. `time_zone` defaults to the account time zone, then `Asia/Shanghai`. Export stops after at most 100,000 rows. Valid `export_fields` keys: incident_id, title, severity, progress, channel_id, channel_name, team_id, team_name, created_at, alert_cnt, active_alert_cnt, alert_event_cnt, seconds_to_ack, seconds_to_close, closed_by, owner_id, owner_name, creator_id, creator_name, closer_id, closer_name, engaged_seconds, hours, notifications, interruptions, acknowledgements, ackers, assignments, reassignments, escalations, manual_escalations, timeout_escalations, assigned_to, raw_assigned_to, escalate_rule_name, responders, raw_responders, snooze_status, snoozed_before, ever_muted, frequency, is_rare, description, labels, fields. When `export_fields` is omitted, all columns are exported.

The success body is a file, not a JSON envelope: it is returned on Response.Raw.

API: POST /insight/incident/export (insightIncidentExport).

func (*AnalyticsService) IncidentList 

func (s *AnalyticsService) IncidentList(ctx context.Context, req *InsightIncidentListRequest) (*InsightIncidentListResponse, *Response, error)

List insight incidents.

Return a paged list of incidents with per-incident handling metrics used by the analytics dashboard.

API: POST /insight/incident/list (insightIncidentList).

func (*AnalyticsService) ResponderExport 

func (s *AnalyticsService) ResponderExport(ctx context.Context, req *InsightQueryRequest) (*Response, error)

Export responder insight.

Export responder insight metrics as a CSV file — one row per responder (and per time/hour bucket when `aggregate_unit`/`split_hours` is used). The response is a CSV stream delivered with `Content-Disposition: attachment` — it is not a JSON envelope. `time_zone` defaults to UTC. Rows without a valid responder ID are skipped. Valid `export_fields` keys: responder_id, responder_name, total_incident_cnt, total_incidents_acknowledged, total_incidents_reassigned, total_incidents_escalated, total_incidents_manually_escalated, total_incidents_timeout_escalated, total_interruptions, total_notifications, total_engaged_seconds, mean_seconds_to_ack, acknowledgement_pct, hours. The `hours` column is included by default only when `split_hours` is true. For compatibility, incident-export column keys are also accepted but produce empty columns.

The success body is a file, not a JSON envelope: it is returned on Response.Raw.

API: POST /insight/responder/export (insightResponderExport).

func (*AnalyticsService) TeamExport 

func (s *AnalyticsService) TeamExport(ctx context.Context, req *InsightQueryRequest) (*Response, error)

Export team insight.

Export team insight metrics as a CSV file — one row per team (and per time/hour bucket when `aggregate_unit`/`split_hours` is used). The response is a CSV stream delivered with `Content-Disposition: attachment` — it is not a JSON envelope. `time_zone` defaults to UTC. Rows without a valid team ID are skipped. Valid `export_fields` keys: team_id, team_name, total_incident_cnt, total_incidents_acknowledged, total_incidents_closed, total_incidents_auto_closed, total_incidents_manually_closed, total_incidents_timeout_closed, total_incidents_escalated, total_incidents_manually_escalated, total_incidents_timeout_escalated, total_incidents_reassigned, total_interruptions, total_notifications, total_engaged_seconds, mean_seconds_to_ack, mean_seconds_to_close, noise_reduction_pct, acknowledgement_pct, total_alert_cnt, total_alert_event_cnt, hours. The `hours` column is included by default only when `split_hours` is true. For compatibility, incident-export column keys are also accepted but produce empty columns.

The success body is a file, not a JSON envelope: it is returned on Response.Raw.

API: POST /insight/team/export (insightTeamExport).

func (*AnalyticsService) TopkAlertsByLabel 

func (s *AnalyticsService) TopkAlertsByLabel(ctx context.Context, req *InsightTopkAlertByLabelRequest) (*InsightAlertByLabelResponse, *Response, error)

Get top-K alerts grouped by check or resource.

Return the top-K alert groups aggregated either by `check` or by `resource` label over the specified time range.

API: POST /insight/alert/topk-by-label (insightTopkAlertsByLabel).

type ApAlertDrop 

type ApAlertDrop struct{}

ApAlertDrop is generated from the Flashduty OpenAPI schema.

type ApAlertInhibit 

type ApAlertInhibit struct {
	// Label keys whose values must be equal between the source and current alert for inhibition to apply.
	Equals []string `json:"equals" toon:"equals"`
	// AND-filter list identifying the source alerts to inhibit — every condition must match.
	SourceFilters []FilterCondition `json:"source_filters" toon:"source_filters"`
}

ApAlertInhibit is generated from the Flashduty OpenAPI schema.

type ApDescriptionReset 

type ApDescriptionReset struct {
	// New description template.
	Description string `json:"description" toon:"description"`
}

ApDescriptionReset is generated from the Flashduty OpenAPI schema.

type ApSeverityReset 

type ApSeverityReset struct {
	// Target severity level.
	Severity string `json:"severity" toon:"severity"`
}

ApSeverityReset is generated from the Flashduty OpenAPI schema.

type ApTitleReset 

type ApTitleReset struct {
	// New title template. Supports Golang template syntax referencing alert fields.
	Title string `json:"title" toon:"title"`
}

ApTitleReset is generated from the Flashduty OpenAPI schema.

type ApplicationsService 

type ApplicationsService service

ApplicationsService handles the "RUM/Applications" API resource.

func (*ApplicationsService) ReadInfo 

func (s *ApplicationsService) ReadInfo(ctx context.Context, req *RUMApplicationIDRequest) (*RUMApplicationItem, *Response, error)

Get application detail.

Retrieve full details of a single RUM application by `application_id`.

API: POST /rum/application/info (rum-application-read-info).

func (*ApplicationsService) ReadInfos 

func (s *ApplicationsService) ReadInfos(ctx context.Context, req *RUMApplicationInfosRequest) (*RUMApplicationInfosResponse, *Response, error)

Batch get applications.

Retrieve details for multiple RUM applications by their IDs in one request.

API: POST /rum/application/infos (rum-application-read-infos).

func (*ApplicationsService) ReadList 

func (s *ApplicationsService) ReadList(ctx context.Context, req *RUMApplicationListRequest) (*RUMApplicationListResponse, *Response, error)

List applications.

Return a paginated list of RUM applications accessible to the current user.

API: POST /rum/application/list (rum-application-read-list).

func (*ApplicationsService) WebhookTest added in v0.5.4 

func (s *ApplicationsService) WebhookTest(ctx context.Context, req *RUMWebhookTestRequest) (*RUMWebhookTestResponse, *Response, error)

Test application webhook.

Send a sample RUM alert event to verify an application's webhook URL.

API: POST /rum/application/webhook/test (rum-application-webhook-test).

func (*ApplicationsService) WriteCreate 

func (s *ApplicationsService) WriteCreate(ctx context.Context, req *RUMApplicationCreateRequest) (*RUMApplicationCreateResponse, *Response, error)

Create application.

Create a new RUM application. Returns the generated `application_id` and `client_token`.

API: POST /rum/application/create (rum-application-write-create).

func (*ApplicationsService) WriteDelete 

func (s *ApplicationsService) WriteDelete(ctx context.Context, req *RUMApplicationIDRequest) (*Response, error)

Delete application.

Delete a RUM application by `application_id`.

API: POST /rum/application/delete (rum-application-write-delete).

func (*ApplicationsService) WriteUpdate 

func (s *ApplicationsService) WriteUpdate(ctx context.Context, req *RUMApplicationUpdateRequest) (*Response, error)

Update application.

Update an existing RUM application. All fields except `application_id` are optional — only provided fields are updated.

API: POST /rum/application/update (rum-application-write-update).

type ArtifactFileStateItem added in v0.14.5 

type ArtifactFileStateItem struct {
	// Artifact ID (`art_` prefix). Also the key of the public-share link.
	ArtifactID string `json:"artifact_id" toon:"artifact_id"`
	// Echoes the requested presented-file ID.
	FileID string `json:"file_id" toon:"file_id"`
	// Console-relative path of the artifact page: `/ai-sre/artifacts/<artifact_id>`.
	GalleryPath string `json:"gallery_path" toon:"gallery_path"`
	// Gallery display title of the published artifact.
	Title string `json:"title" toon:"title"`
}

ArtifactFileStateItem is generated from the Flashduty OpenAPI schema.

type ArtifactFileStateRequest added in v0.14.5 

type ArtifactFileStateRequest struct {
	// Presented-file IDs (`pf_` prefix) to probe. At most 50 per call; duplicates and empty strings are ignored.
	FileIDs []string `json:"file_ids" toon:"file_ids"`
}

ArtifactFileStateRequest is generated from the Flashduty OpenAPI schema.

type ArtifactFileStateResponse added in v0.14.5 

type ArtifactFileStateResponse struct {
	// One entry per requested file that has a live published artifact; files without one are omitted.
	Items []ArtifactFileStateItem `json:"items" toon:"items"`
}

ArtifactFileStateResponse is generated from the Flashduty OpenAPI schema.

type ArtifactIDRequest added in v0.14.5 

type ArtifactIDRequest struct {
	// Artifact ID (`art_` prefix). Also the key of the public-share link.
	ArtifactID string `json:"artifact_id" toon:"artifact_id"`
}

ArtifactIDRequest is generated from the Flashduty OpenAPI schema.

type ArtifactListRequest added in v0.14.5 

type ArtifactListRequest struct {
	// Sort ascending when true, descending when false. Applies only when `orderby` is set.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Page size. Defaults to 20; capped at 100.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
	// Sort field: `created_at` or `updated_at`. Empty means `updated_at` descending.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Page number, 1-based.
	Page int64 `json:"page,omitempty" toon:"page,omitempty"`
	// Case-insensitive substring match on the artifact title.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Visibility scope. `all` (default) lists the caller's own personal artifacts plus artifacts of every team the caller belongs to; `personal` lists only the caller's own; `team` lists only team-owned artifacts of the caller's teams.
	Scope string `json:"scope,omitempty" toon:"scope,omitempty"`
	// Restrict to artifacts owned by these team IDs, intersected with the caller's visibility — teams the caller does not belong to silently return nothing.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

ArtifactListRequest is generated from the Flashduty OpenAPI schema.

type ArtifactListResponse added in v0.14.5 

type ArtifactListResponse struct {
	// Artifacts on this page.
	Items []PublishedArtifactItem `json:"items" toon:"items"`
	// Total number of artifacts matching the filter across all pages.
	Total int64 `json:"total" toon:"total"`
}

ArtifactListResponse is generated from the Flashduty OpenAPI schema.

type ArtifactPublishFromFileRequest added in v0.14.5 

type ArtifactPublishFromFileRequest struct {
	// Presented-file ID (`pf_` prefix) of a file produced in a session, as shown on the file card in chat.
	FileID string `json:"file_id" toon:"file_id"`
	// Gallery display title. Trimmed; must be non-empty.
	Title string `json:"title" toon:"title"`
}

ArtifactPublishFromFileRequest is generated from the Flashduty OpenAPI schema.

type ArtifactPublishResponse added in v0.14.5 

type ArtifactPublishResponse struct {
	// Artifact ID (`art_` prefix). Also the key of the public-share link.
	ArtifactID string `json:"artifact_id" toon:"artifact_id"`
	// Console-relative path of the artifact page: `/ai-sre/artifacts/<artifact_id>`.
	GalleryPath string `json:"gallery_path" toon:"gallery_path"`
	// Gallery display title.
	Title string `json:"title" toon:"title"`
}

ArtifactPublishResponse is generated from the Flashduty OpenAPI schema.

type ArtifactShareState added in v0.14.5 

type ArtifactShareState struct {
	// Artifact ID (`art_` prefix). Also the key of the public-share link.
	ArtifactID string `json:"artifact_id" toon:"artifact_id"`
	// Anonymous public link served entirely from CDN. Anyone with the link can view the content, no login required.
	PublicURL string `json:"public_url" toon:"public_url"`
	// Always `true` in this response.
	ShareEnabled bool `json:"share_enabled" toon:"share_enabled"`
	// Unix timestamp in milliseconds of the last share enable or snapshot sync.
	SharedAt TimestampMilli `json:"shared_at" toon:"shared_at"`
	// Person ID of the member who enabled sharing.
	SharedBy int64 `json:"shared_by" toon:"shared_by"`
}

ArtifactShareState is generated from the Flashduty OpenAPI schema.

type ArtifactSignRequest added in v0.14.5 

type ArtifactSignRequest struct {
	// Presented-file ID (`pf_` prefix) to sign.
	FileID string `json:"file_id" toon:"file_id"`
	// Optional session share-link token. Needed only when the caller reaches the file through a shared session link rather than account membership.
	ShareToken string `json:"share_token,omitempty" toon:"share_token,omitempty"`
}

ArtifactSignRequest is generated from the Flashduty OpenAPI schema.

type ArtifactUpdateRequest added in v0.14.5 

type ArtifactUpdateRequest struct {
	// Artifact ID (`art_` prefix). Also the key of the public-share link.
	ArtifactID string `json:"artifact_id" toon:"artifact_id"`
	// Transfer target scope. `0` moves the artifact to personal scope (only the creator can manage it); a positive value moves it to a team the caller must belong to. Omit to leave unchanged.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// New title. Trimmed; must be non-empty when provided. Omit to leave unchanged.
	Title *string `json:"title,omitempty" toon:"title,omitempty"`
}

ArtifactUpdateRequest is generated from the Flashduty OpenAPI schema.

type ArtifactsReadStreamRequest added in v0.14.5 

type ArtifactsReadStreamRequest struct {
	// Signed token issued by `POST /safari/artifact/sign`. Bound to the calling account and person; valid for 5 minutes.
	T string `url:"t"`
	// `download` (default) serves the file as an attachment; `preview` serves it inline for browser display. Any other value falls back to `download`.
	Mode string `url:"mode,omitempty"`
}

ArtifactsReadStreamRequest holds the query parameters for Download or preview a file.

type ArtifactsService added in v0.14.5 

type ArtifactsService service

ArtifactsService handles the "AI SRE/Artifacts" API resource.

func (*ArtifactsService) ReadGet added in v0.14.5 

func (s *ArtifactsService) ReadGet(ctx context.Context, req *ArtifactIDRequest) (*PublishedArtifactItem, *Response, error)

Get artifact detail.

Get a single published artifact by ID.

API: POST /safari/artifact/gallery/get (artifact-read-get).

func (*ArtifactsService) ReadGetFileState added in v0.14.5 

func (s *ArtifactsService) ReadGetFileState(ctx context.Context, req *ArtifactFileStateRequest) (*ArtifactFileStateResponse, *Response, error)

Get file publish state.

Check which presented files already have a live published artifact.

API: POST /safari/artifact/gallery/file-state (artifact-read-get-file-state).

func (*ArtifactsService) ReadList added in v0.14.5 

func (s *ArtifactsService) ReadList(ctx context.Context, req *ArtifactListRequest) (*ArtifactListResponse, *Response, error)

List artifacts.

List published artifacts visible to the caller, with pagination and title search.

API: POST /safari/artifact/gallery/list (artifact-read-list).

func (*ArtifactsService) ReadSign added in v0.14.5 

func (s *ArtifactsService) ReadSign(ctx context.Context, req *ArtifactSignRequest) (*SignedUrLs, *Response, error)

Create signed file URLs.

Create short-lived signed URLs to download or preview a presented file.

API: POST /safari/artifact/sign (artifact-read-sign).

func (*ArtifactsService) ReadStream added in v0.14.5 

func (s *ArtifactsService) ReadStream(ctx context.Context, req *ArtifactsReadStreamRequest) (*Response, error)

Download or preview a file.

Download or preview a file's bytes using a signed token.

The success body is a file, not a JSON envelope: it is returned on Response.Raw.

API: GET /safari/artifact/stream (artifact-read-stream).

func (*ArtifactsService) WriteDelete added in v0.14.5 

func (s *ArtifactsService) WriteDelete(ctx context.Context, req *ArtifactIDRequest) (*any, *Response, error)

Remove artifact from gallery.

Detach an artifact from the gallery; the source file stays with its session.

API: POST /safari/artifact/gallery/delete (artifact-write-delete).

func (*ArtifactsService) WritePublish added in v0.14.5 

func (s *ArtifactsService) WritePublish(ctx context.Context, req *ArtifactPublishFromFileRequest) (*ArtifactPublishResponse, *Response, error)

Publish file as artifact.

Publish a session-produced file to the artifact gallery.

API: POST /safari/artifact/gallery/publish-from-file (artifact-write-publish).

func (*ArtifactsService) WriteShareEnable added in v0.14.5 

func (s *ArtifactsService) WriteShareEnable(ctx context.Context, req *ArtifactIDRequest) (*ArtifactShareState, *Response, error)

Enable public sharing.

Turn on anonymous public sharing for an artifact and return its public link.

API: POST /safari/artifact/gallery/share/enable (artifact-write-share-enable).

func (*ArtifactsService) WriteShareRevoke added in v0.14.5 

func (s *ArtifactsService) WriteShareRevoke(ctx context.Context, req *ArtifactIDRequest) (*any, *Response, error)

Revoke public sharing.

Turn off public sharing; the link stops resolving immediately.

API: POST /safari/artifact/gallery/share/revoke (artifact-write-share-revoke).

func (*ArtifactsService) WriteShareSync added in v0.14.5 

func (s *ArtifactsService) WriteShareSync(ctx context.Context, req *ArtifactIDRequest) (*ArtifactShareState, *Response, error)

Update shared snapshot.

Refresh the public snapshot of a shared artifact with its latest content.

API: POST /safari/artifact/gallery/share/sync (artifact-write-share-sync).

func (*ArtifactsService) WriteUpdate added in v0.14.5 

func (s *ArtifactsService) WriteUpdate(ctx context.Context, req *ArtifactUpdateRequest) (*PublishedArtifactItem, *Response, error)

Update artifact.

Rename an artifact or transfer it between personal and team scope.

API: POST /safari/artifact/gallery/update (artifact-write-update).

type AssignIncidentRequest 

type AssignIncidentRequest struct {
	// Assign target; at least one of `person_ids` and `escalate_rule_id` must be set.
	AssignedTo AssignedTo `json:"assigned_to" toon:"assigned_to"`
	// Single incident ID. Ignored when `incident_ids` is also provided.
	IncidentID string `json:"incident_id,omitempty" toon:"incident_id,omitempty"`
	// Incident IDs to assign in bulk; obtain them from `POST /incident/list`.
	IncidentIDs []string `json:"incident_ids,omitempty" toon:"incident_ids,omitempty"`
}

AssignIncidentRequest is generated from the Flashduty OpenAPI schema.

type AssignedTo 

type AssignedTo struct {
	// Unix timestamp (seconds) when the assignment was made.
	AssignedAt int64 `json:"assigned_at,omitempty" toon:"assigned_at,omitempty"`
	// Email recipients, used by integrations such as ServiceNow.
	Emails []string `json:"emails,omitempty" toon:"emails,omitempty"`
	// Escalation rule ID (MongoDB ObjectID) to drive assignment.
	EscalateRuleID string `json:"escalate_rule_id,omitempty" toon:"escalate_rule_id,omitempty"`
	// Escalation rule display name, filled by the server.
	EscalateRuleName string `json:"escalate_rule_name,omitempty" toon:"escalate_rule_name,omitempty"`
	// Opaque assignment ID generated by the server.
	ID string `json:"id,omitempty" toon:"id,omitempty"`
	// Current level index within the escalation rule.
	LayerIdx int64 `json:"layer_idx,omitempty" toon:"layer_idx,omitempty"`
	// Override the notification channels used for this assignment.
	Notify AssignedToNotify `json:"notify,omitzero" toon:"notify,omitempty"`
	// Member IDs to assign directly.
	PersonIDs []int64 `json:"person_ids,omitempty" toon:"person_ids,omitempty"`
	// Assignment type: `assign` direct assignment, `reassign` reassignment, `escalate` escalation-rule driven, `reopen` automatic reassignment on reopen.
	Type string `json:"type,omitempty" toon:"type,omitempty"`
}

AssignedTo is generated from the Flashduty OpenAPI schema.

type AssignedToNotify added in v0.12.1 

type AssignedToNotify struct {
	// When false, use `personal_channels`; when true or omitted, use each responder's personal preference.
	FollowPreference *bool `json:"follow_preference,omitempty" toon:"follow_preference,omitempty"`
	// Channels to use (e.g. `voice`, `sms`, `email`).
	PersonalChannels []string `json:"personal_channels,omitempty" toon:"personal_channels,omitempty"`
	// Notification template ID (MongoDB ObjectID).
	TemplateID string `json:"template_id,omitempty" toon:"template_id,omitempty"`
}

AssignedToNotify is generated from the Flashduty OpenAPI schema.

type AuditLog 

type AuditLog struct {
	// ID of the account.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// JSON-encoded request body. Bodies containing sensitive fields are base64url-encoded instead; bodies over 10 KB are replaced by a truncation placeholder.
	Body string `json:"body" toon:"body"`
	// Timestamp of the operation in Unix epoch milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// ID of the credential (the app key ID) when `credential_type` is `app_key`; 0 otherwise.
	CredentialID uint64 `json:"credential_id" toon:"credential_id"`
	// Credential type used for the call. `app_key` when authenticated with an app key; empty string for member sessions.
	CredentialType string `json:"credential_type" toon:"credential_type"`
	// Client IP address of the caller.
	IP string `json:"ip" toon:"ip"`
	// True if this is flagged as a high-risk operation.
	IsDangerous bool `json:"is_dangerous" toon:"is_dangerous"`
	// True for mutating operations; false for read-only ones.
	IsWrite bool `json:"is_write" toon:"is_write"`
	// ID of the member who performed the action. 0 when the action was performed by the account principal itself.
	MemberID uint64 `json:"member_id" toon:"member_id"`
	// Display name of the member. Empty when `member_id` is 0.
	MemberName string `json:"member_name" toon:"member_name"`
	// Stable machine-readable operation name, e.g. `template:write:create`.
	Operation string `json:"operation" toon:"operation"`
	// Human-readable Chinese label of the operation (e.g. `创建模板`).
	OperationName string `json:"operation_name" toon:"operation_name"`
	// URL path parameters as an array of key-value pairs, or an empty array when none.
	Params []AuditLogParamsItem `json:"params" toon:"params"`
	// Kind of the caller. `member` — an interactive member session; `service` — an app key credential.
	PrincipalKind string `json:"principal_kind" toon:"principal_kind"`
	// Unique request ID for correlation.
	RequestID string `json:"request_id" toon:"request_id"`
}

AuditLog is generated from the Flashduty OpenAPI schema.

type AuditLogParamsItem 

type AuditLogParamsItem struct {
	// Name of a URL path parameter (the `:xxx` placeholder in the route).
	Key string `json:"Key" toon:"Key"`
	// The actual value of that path parameter in this request.
	Value string `json:"Value" toon:"Value"`
}

AuditLogParamsItem is generated from the Flashduty OpenAPI schema.

type AuditLogsService 

type AuditLogsService service

AuditLogsService handles the "Platform/Audit logs" API resource.

func (*AuditLogsService) OperationList 

func (s *AuditLogsService) OperationList(ctx context.Context) (*AuditOperationListResponse, *Response, error)

List auditable operation types.

Return all operation names that are recorded in the audit log, for use as `operations` filter values.

API: POST /audit/operation/list (audit-read-operation-list).

func (*AuditLogsService) Search 

func (s *AuditLogsService) Search(ctx context.Context, req *AuditSearchRequest) (*AuditSearchResponse, *Response, error)

Search audit logs.

Return a cursor-paginated list of audit log entries within a time range.

API: POST /audit/search (audit-read-search).

type AuditOperationListRequest 

type AuditOperationListRequest struct{}

AuditOperationListRequest is generated from the Flashduty OpenAPI schema.

type AuditOperationListResponse 

type AuditOperationListResponse struct {
	// Array of all auditable operation types (only APIs flagged for audit); always an array, possibly empty.
	Items []AuditOperationTypeItem `json:"items" toon:"items"`
}

AuditOperationListResponse is generated from the Flashduty OpenAPI schema.

type AuditOperationTypeItem 

type AuditOperationTypeItem struct {
	// Stable machine-readable operation name for use as a filter.
	Name string `json:"name" toon:"name"`
	// Human-readable Chinese label shown in the console.
	NameCn string `json:"name_cn" toon:"name_cn"`
}

AuditOperationTypeItem is generated from the Flashduty OpenAPI schema.

type AuditRecordIDRequest added in v0.5.3 

type AuditRecordIDRequest struct {
	// Audit record ID — the `id` of an audit row returned by `POST /monit/rule/audits`, NOT the rule ID. Passing a rule ID returns HTTP 400.
	ID uint64 `json:"id" toon:"id"`
}

AuditRecordIDRequest is generated from the Flashduty OpenAPI schema.

type AuditSearchRequest 

type AuditSearchRequest struct {
	// End of the search window, Unix epoch seconds. Inclusive. Must be after `start_time`; maximum span 90 days.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// When true, return only high-risk (dangerous) operations.
	IsDangerous *bool `json:"is_dangerous,omitempty" toon:"is_dangerous,omitempty"`
	// When true, return only write operations; when false, return only read operations.
	IsWrite *bool `json:"is_write,omitempty" toon:"is_write,omitempty"`
	// Page size, 0–99. Omit or set to 0 for no page-size cap — all matching rows in the window are returned.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
	// Filter to specific operation names. Use `POST /audit/operation/list` to get the valid set.
	Operations []string `json:"operations,omitempty" toon:"operations,omitempty"`
	// Filter by the operator's member ID (get IDs from `POST /member/list`). Pass the account ID to match actions performed by the account principal itself.
	PersonID uint64 `json:"person_id,omitempty" toon:"person_id,omitempty"`
	// Filter to a single request by its unique request ID.
	RequestID string `json:"request_id,omitempty" toon:"request_id,omitempty"`
	// Opaque pagination cursor returned by the previous response. Leave empty for the first page.
	SearchAfterCtx string `json:"search_after_ctx,omitempty" toon:"search_after_ctx,omitempty"`
	// Start of the search window, Unix epoch seconds. Exclusive — entries at exactly this second are not included.
	StartTime int64 `json:"start_time" toon:"start_time"`
}

AuditSearchRequest is generated from the Flashduty OpenAPI schema.

type AuditSearchResponse 

type AuditSearchResponse struct {
	// Audit log entries for this page, newest first. Omitted when the page is empty.
	Docs []AuditLog `json:"docs" toon:"docs"`
	// Opaque cursor for the next page. Empty string when there are no more results.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total matching entries in the search window.
	Total int64 `json:"total" toon:"total"`
}

AuditSearchResponse is generated from the Flashduty OpenAPI schema.

type AutomationFireAPITriggerRequest added in v0.5.4 

type AutomationFireAPITriggerRequest struct {
	// Context text passed to this Automation run.
	Text string `json:"text,omitempty" toon:"text,omitempty"`
}

AutomationFireAPITriggerRequest is the payload accepted by an Automation HTTP POST trigger.

type AutomationFireAPITriggerResponse added in v0.5.4 

type AutomationFireAPITriggerResponse struct {
	// Result type. The API-trigger success path returns routine_fire.
	Type string `json:"type" toon:"type"`
	// Started session ID returned by the API-trigger success path.
	SessionID string `json:"session_id" toon:"session_id"`
	// Console URL for the started session.
	SessionURL string `json:"session_url" toon:"session_url"`
}

AutomationFireAPITriggerResponse is the result returned by an Automation HTTP POST trigger.

type AutomationRuleCreateRequest added in v0.5.4 

type AutomationRuleCreateRequest struct {
	// Run cadence. Supports 4 fields (`hour day month weekday`, minute defaults to 0) and 5 fields (`minute hour day month weekday`). The minute must be one fixed integer; 6-field seconds are not supported. A cron that sets both day-of-month and day-of-week is rejected. The create API currently requires this field even for HTTP-POST-only rules; send a valid cron and set `schedule_trigger_enabled=false`.
	CronExpr string `json:"cron_expr" toon:"cron_expr"`
	// Whether the rule is enabled after creation. Omitted API value is false; Chat/CLI create sends true by default unless the user asks for disabled.
	Enabled bool `json:"enabled,omitempty" toon:"enabled,omitempty"`
	// BYOC Runner ID. Used only when `environment_kind=byoc`.
	EnvironmentID string `json:"environment_id,omitempty" toon:"environment_id,omitempty"`
	// Runtime environment kind. Omit or send an empty value for automatic selection. One of: `cloud` (platform-hosted cloud sandbox), `byoc` (a self-hosted BYOC runner in the account, used with `environment_id`); automatic selection prefers an online BYOC runner and falls back to the cloud sandbox.
	EnvironmentKind string `json:"environment_kind,omitempty" toon:"environment_kind,omitempty"`
	// Whether to create and enable an HTTP POST trigger. When enabled, the response includes a one-time token.
	HTTPPostTriggerEnabled bool `json:"http_post_trigger_enabled,omitempty" toon:"http_post_trigger_enabled,omitempty"`
	// Rule name.
	Name string `json:"name" toon:"name"`
	// On-call integration IDs to watch. Creating or enabling this trigger requires at least one valid ID.
	OncallIncidentChannelIDs []int64 `json:"oncall_incident_channel_ids,omitempty" toon:"oncall_incident_channel_ids,omitempty"`
	// Incident severities to watch. Supported values are Critical, Warning, and Info; creating or enabling this trigger requires at least one value.
	OncallIncidentSeverities []string `json:"oncall_incident_severities,omitempty" toon:"oncall_incident_severities,omitempty"`
	// Whether the On-call incident trigger is enabled.
	OncallIncidentTriggerEnabled bool `json:"oncall_incident_trigger_enabled,omitempty" toon:"oncall_incident_trigger_enabled,omitempty"`
	// Task prompt sent to the AI SRE agent on each run.
	Prompt string `json:"prompt" toon:"prompt"`
	// Whether the schedule trigger is enabled. Defaults to true when omitted; HTTP-POST-only rules should send false.
	ScheduleTriggerEnabled *bool `json:"schedule_trigger_enabled,omitempty" toon:"schedule_trigger_enabled,omitempty"`
	// Scope team ID. 0 or omitted means a personal rule; >0 means a team in the account. Can be reassigned later via update (converting a team rule to personal is owner-only; moving into a team requires the caller to belong to it).
	TeamID int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// IANA timezone `cron_expr` is evaluated in, e.g. `Asia/Shanghai`. Must be a timezone name loadable by the server; an invalid value is rejected. Defaults to the caller's member timezone, then the account timezone, then the server default (Asia/Shanghai) when omitted.
	Timezone string `json:"timezone,omitempty" toon:"timezone,omitempty"`
}

AutomationRuleCreateRequest is generated from the Flashduty OpenAPI schema.

type AutomationRuleIDRequest added in v0.5.4 

type AutomationRuleIDRequest struct {
	// Rule ID, from the list returned by `POST /safari/automation/rule/list`.
	RuleID string `json:"rule_id" toon:"rule_id"`
}

AutomationRuleIDRequest is generated from the Flashduty OpenAPI schema.

type AutomationRuleItem added in v0.5.4 

type AutomationRuleItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// True when the caller can manage this rule: the personal rule owner; for team rules, an account admin or a member of the rule's team.
	CanEdit bool `json:"can_edit" toon:"can_edit"`
	// Creation time, Unix milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Normalized 5-field cron expression.
	CronExpr string `json:"cron_expr" toon:"cron_expr"`
	// Whether the rule is enabled.
	Enabled bool `json:"enabled" toon:"enabled"`
	// BYOC Runner ID.
	EnvironmentID string `json:"environment_id" toon:"environment_id"`
	// Runtime environment kind. Omit or send an empty value for automatic selection. One of: `cloud` (platform-hosted cloud sandbox), `byoc` (self-hosted BYOC runner in the account); an empty value means automatic selection (prefers an online BYOC runner, falls back to the cloud sandbox).
	EnvironmentKind string `json:"environment_kind" toon:"environment_kind"`
	// HTTP POST trigger token. Returned only on create or token rotation; save it immediately.
	HTTPPostToken string `json:"http_post_token" toon:"http_post_token"`
	// Whether the HTTP POST trigger is enabled.
	HTTPPostTriggerEnabled bool `json:"http_post_trigger_enabled" toon:"http_post_trigger_enabled"`
	// HTTP POST trigger ID. Omitted when the rule has no HTTP POST trigger.
	HTTPPostTriggerID string `json:"http_post_trigger_id" toon:"http_post_trigger_id"`
	// HTTP POST trigger path. Omitted when the rule has no HTTP POST trigger.
	HTTPPostTriggerURL string `json:"http_post_trigger_url" toon:"http_post_trigger_url"`
	// Rule name.
	Name string `json:"name" toon:"name"`
	// On-call integration IDs to watch. Creating or enabling this trigger requires at least one valid ID. Omitted when no On-call incident trigger is configured.
	OncallIncidentChannelIDs []int64 `json:"oncall_incident_channel_ids" toon:"oncall_incident_channel_ids"`
	// Incident severities to watch. Supported values are Critical, Warning, and Info; creating or enabling this trigger requires at least one value. Omitted when no On-call incident trigger is configured.
	OncallIncidentSeverities []string `json:"oncall_incident_severities" toon:"oncall_incident_severities"`
	// Whether the On-call incident trigger is enabled.
	OncallIncidentTriggerEnabled bool `json:"oncall_incident_trigger_enabled" toon:"oncall_incident_trigger_enabled"`
	// On-call incident trigger ID. Omitted when the rule has no On-call incident trigger.
	OncallIncidentTriggerID string `json:"oncall_incident_trigger_id" toon:"oncall_incident_trigger_id"`
	// Creator person ID.
	OwnerID int64 `json:"owner_id" toon:"owner_id"`
	// Task prompt.
	Prompt string `json:"prompt" toon:"prompt"`
	// Rule ID.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Hidden session run scope. One of: `person` (personal rule, team_id=0, runs as the creator; disabled when the creator leaves the account), `team` (team rule, team_id>0, owned by the team and shared with its members; survives the creator leaving). Derived from the rule's team_id.
	RunScope string `json:"run_scope" toon:"run_scope"`
	// Next scheduled fire time, Unix milliseconds. 0 means no future scheduled fire is available.
	ScheduleNextFireAtMs TimestampMilli `json:"schedule_next_fire_at_ms" toon:"schedule_next_fire_at_ms"`
	// Whether the schedule trigger is enabled.
	ScheduleTriggerEnabled bool `json:"schedule_trigger_enabled" toon:"schedule_trigger_enabled"`
	// Schedule trigger ID. Omitted if the rule has no schedule trigger.
	ScheduleTriggerID string `json:"schedule_trigger_id" toon:"schedule_trigger_id"`
	// Scope team ID; 0 means personal rule.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// IANA timezone `cron_expr` is evaluated in. Always populated for rules created after this field shipped; empty on legacy rows created before it, which still resolve to UTC when scheduled.
	Timezone string `json:"timezone" toon:"timezone"`
	// Last update time, Unix milliseconds.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
}

AutomationRuleItem is generated from the Flashduty OpenAPI schema.

type AutomationRuleListRequest added in v0.5.4 

type AutomationRuleListRequest struct {
	ListOptions
	// Filter by enabled state: `true` returns only enabled rules, `false` only disabled; omit or pass null for no filter.
	Enabled *bool `json:"enabled,omitempty" toon:"enabled,omitempty"`
	// Compatibility field; when scope is empty and this is false, behaves like team scope.
	IncludePerson *bool `json:"include_person,omitempty" toon:"include_person,omitempty"`
	// Filter by name keyword.
	Keyword string `json:"keyword,omitempty" toon:"keyword,omitempty"`
	// Scope filter: `all` (own personal + accessible team rules), `personal`, or `team`; default `all`.
	Scope string `json:"scope,omitempty" toon:"scope,omitempty"`
	// Filter to these team IDs; this narrows results and does not expand access.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

AutomationRuleListRequest is generated from the Flashduty OpenAPI schema.

type AutomationRuleListResponse added in v0.5.4 

type AutomationRuleListResponse struct {
	// Array of automation rules for the current page, used with `total` for pagination.
	Rules []AutomationRuleItem `json:"rules" toon:"rules"`
	// Total count.
	Total int64 `json:"total" toon:"total"`
}

AutomationRuleListResponse is generated from the Flashduty OpenAPI schema.

type AutomationRuleUpdateRequest added in v0.5.4 

type AutomationRuleUpdateRequest struct {
	// Target rule ID.
	RuleID string `json:"rule_id,omitempty" toon:"rule_id,omitempty"`
	// New rule name.
	Name *string `json:"name,omitempty" toon:"name,omitempty"`
	// Only the current value is accepted; personal/team scope is immutable after creation.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Whether the rule is enabled.
	Enabled *bool `json:"enabled,omitempty" toon:"enabled,omitempty"`
	// Run cadence. Supports 4 fields (`hour day month weekday`, minute defaults to 0) and 5 fields (`minute hour day month weekday`).
	CronExpr *string `json:"cron_expr,omitempty" toon:"cron_expr,omitempty"`
	// Whether the schedule trigger is enabled.
	ScheduleTriggerEnabled *bool `json:"schedule_trigger_enabled,omitempty" toon:"schedule_trigger_enabled,omitempty"`
	// New task prompt.
	Prompt *string `json:"prompt,omitempty" toon:"prompt,omitempty"`
	// Runtime environment kind. Omit or send an empty value for automatic selection.
	EnvironmentKind *string `json:"environment_kind,omitempty" toon:"environment_kind,omitempty"`
	// BYOC Runner ID.
	EnvironmentID *string `json:"environment_id,omitempty" toon:"environment_id,omitempty"`
	// Whether the HTTP POST trigger is enabled. Sending true creates one when missing.
	HTTPPostTriggerEnabled *bool `json:"http_post_trigger_enabled,omitempty" toon:"http_post_trigger_enabled,omitempty"`
	// Whether to rotate the HTTP POST trigger token. The new token is returned only in this response.
	RotateHTTPPostTriggerToken bool `json:"rotate_http_post_trigger_token,omitempty" toon:"rotate_http_post_trigger_token,omitempty"`
	// Whether the on-call incident trigger is enabled. Sending true creates it when missing and channel/severity filters are provided.
	OncallIncidentTriggerEnabled *bool `json:"oncall_incident_trigger_enabled,omitempty" toon:"oncall_incident_trigger_enabled,omitempty"`
	// On-call channel IDs whose new incidents can trigger this rule.
	OncallIncidentChannelIDs *[]int64 `json:"oncall_incident_channel_ids,omitempty" toon:"oncall_incident_channel_ids,omitempty"`
	// Incident severities that can trigger this rule.
	OncallIncidentSeverities *[]string `json:"oncall_incident_severities,omitempty" toon:"oncall_incident_severities,omitempty"`
}

AutomationRuleUpdateRequest updates mutable fields on an Automation rule. Pointer fields preserve partial-update semantics: nil means leave unchanged, while a non-nil zero value is sent to the API.

type AutomationRunItem added in v0.5.4 

type AutomationRunItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Attempt count.
	Attempts int64 `json:"attempts" toon:"attempts"`
	// Completion time, Unix milliseconds. 0 means not completed.
	CompletedAt TimestampMilli `json:"completed_at" toon:"completed_at"`
	// Creation time, Unix milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Duration in milliseconds.
	DurationMs int64 `json:"duration_ms" toon:"duration_ms"`
	// Error code; empty when the run did not fail.
	ErrorCode string `json:"error_code" toon:"error_code"`
	// Error message; empty when the run did not fail.
	ErrorMessage string `json:"error_message" toon:"error_message"`
	// Run kind; runs listed for a rule are always `automation_rule`.
	Kind string `json:"kind" toon:"kind"`
	// Idempotency key for this occurrence.
	OccurrenceKey string `json:"occurrence_key" toon:"occurrence_key"`
	// Raw run result JSON (carries the run's `session_id` once started); null when empty.
	ResultJSON map[string]any `json:"result_json" toon:"result_json"`
	// Rule ID.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Run ID.
	RunID string `json:"run_id" toon:"run_id"`
	// Session created for this run, extracted from `result_json`. Omitted when the run has not (yet) started a session.
	SessionID string `json:"session_id" toon:"session_id"`
	// Display name of the run's session, stamped via a batch lookup. Omitted when empty or when the lookup fails.
	SessionName string `json:"session_name" toon:"session_name"`
	// Start time, Unix milliseconds.
	StartedAt TimestampMilli `json:"started_at" toon:"started_at"`
	// Raw run statistics JSON; null when empty.
	StatsJSON map[string]any `json:"stats_json" toon:"stats_json"`
	// Run status. One of (the first three are in-flight, the rest terminal):
	// | Value | Meaning |
	// | --- | --- |
	// | `queued` | Enqueued, waiting for a worker |
	// | `running` | Executing |
	// | `retrying` | An attempt failed and a retry is scheduled |
	// | `succeeded` | Completed successfully |
	// | `partial` | Partially succeeded (currently only produced by memory-consolidation runs; rule runs never reach it) |
	// | `failed` | Terminal failure, no further retries |
	// | `skipped` | Not executed (e.g. grace period expired, trigger or rule invalid); the reason is kept on the run record |
	// | `abandoned` | Still in-flight past the stale threshold and swept as never-completed (e.g. worker died) |
	// | `blocked` | Terminal: the run produced output but ended with a connector waiting on a human to complete authorization (distinct from `failed`) |
	Status string `json:"status" toon:"status"`
	// Trigger kind. One of:
	// | Value | Meaning |
	// | --- | --- |
	// | `schedule` | Fired by the rule's schedule trigger |
	// | `debug` | Debug run (reserved; current rule runs never carry this kind) |
	// | `manual` | Triggered manually by a user |
	// | `http_post` | Fired via the rule's HTTP POST webhook |
	// | `oncall_incident` | Fired by an on-call incident event |
	TriggerKind string `json:"trigger_kind" toon:"trigger_kind"`
	// Last update time, Unix milliseconds.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
}

AutomationRunItem is generated from the Flashduty OpenAPI schema.

type AutomationRunListRequest added in v0.5.4 

type AutomationRunListRequest struct {
	ListOptions
	// Target rule ID, from the list returned by `POST /safari/automation/rule/list`.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Start-time lower bound, Unix milliseconds. Values below the 180-day run-history retention floor are clamped to it (that floor is also the default when omitted).
	StartedAfterMs int64 `json:"started_after_ms,omitempty" toon:"started_after_ms,omitempty"`
	// Start-time upper bound, Unix milliseconds. Must be greater than or equal to the effective `started_after_ms`; a value below the retention floor yields an empty result.
	StartedBeforeMs int64 `json:"started_before_ms,omitempty" toon:"started_before_ms,omitempty"`
	// Run status filter: `queued`, `running`, `retrying`, `succeeded`, `partial` (partially succeeded), `failed`, `skipped` (e.g. rule or trigger no longer valid), `abandoned` (stale run terminated by the system), `blocked` (terminal; produced output but a connector is waiting on a human authorization); omit for no filter.
	Status string `json:"status,omitempty" toon:"status,omitempty"`
	// Trigger source filter: `schedule` cron trigger, `debug` debug run, `manual` manual run, `http_post` HTTP POST trigger, `oncall_incident` on-call incident trigger; omit for no filter.
	TriggerKind string `json:"trigger_kind,omitempty" toon:"trigger_kind,omitempty"`
}

AutomationRunListRequest is generated from the Flashduty OpenAPI schema.

type AutomationRunListResponse added in v0.5.4 

type AutomationRunListResponse struct {
	// Array of run records for the given `rule_id`, filtered by the request's status/trigger-kind/time-range and paginated.
	Runs []AutomationRunItem `json:"runs" toon:"runs"`
	// Total count.
	Total int64 `json:"total" toon:"total"`
}

AutomationRunListResponse is generated from the Flashduty OpenAPI schema.

type AutomationRunView added in v0.5.7 

type AutomationRunView struct {
	// Run ID, always populated once a run is created.
	RunID string `json:"run_id" toon:"run_id"`
	// AI SRE session ID for this run. Always populated in a 200 response, since the call only returns after the session has started.
	SessionID string `json:"session_id" toon:"session_id"`
}

AutomationRunView is generated from the Flashduty OpenAPI schema.

type AutomationTemplateItem added in v0.5.4 

type AutomationTemplateItem struct {
	// Template description.
	Description string `json:"description" toon:"description"`
	// Whether a rule created from this template starts out enabled (prefill value).
	Enabled bool `json:"enabled" toon:"enabled"`
	// Icon identifier.
	Icon string `json:"icon" toon:"icon"`
	// Template name.
	Name string `json:"name" toon:"name"`
	// Template prompt.
	Prompt string `json:"prompt" toon:"prompt"`
}

AutomationTemplateItem is generated from the Flashduty OpenAPI schema.

type AutomationTemplateListRequest added in v0.5.4 

type AutomationTemplateListRequest struct {
	// Template locale such as zh-CN or en-US. Omit to detect from the request locale.
	Locale string `json:"locale,omitempty" toon:"locale,omitempty"`
}

AutomationTemplateListRequest is generated from the Flashduty OpenAPI schema.

type AutomationTemplateListResponse added in v0.5.4 

type AutomationTemplateListResponse struct {
	// Array of built-in automation templates, with display text localized by the request `locale` (falling back to request headers).
	Templates []AutomationTemplateItem `json:"templates" toon:"templates"`
}

AutomationTemplateListResponse is generated from the Flashduty OpenAPI schema.

type AutomationsService added in v0.5.4 

type AutomationsService service

AutomationsService handles the "AI SRE/Automations" API resource.

func (*AutomationsService) RuleReadGet added in v0.5.4 

func (s *AutomationsService) RuleReadGet(ctx context.Context, req *AutomationRuleIDRequest) (*AutomationRuleItem, *Response, error)

Get Automation rule.

Get one Automation rule by ID.

API: POST /safari/automation/rule/get (automation-rule-read-get).

func (*AutomationsService) RuleReadList added in v0.5.4 

func (s *AutomationsService) RuleReadList(ctx context.Context, req *AutomationRuleListRequest) (*AutomationRuleListResponse, *Response, error)

List Automation rules.

List Automation rules visible to the caller.

API: POST /safari/automation/rule/list (automation-rule-read-list).

func (*AutomationsService) RuleWriteCreate added in v0.5.4 

func (s *AutomationsService) RuleWriteCreate(ctx context.Context, req *AutomationRuleCreateRequest) (*AutomationRuleItem, *Response, error)

Create Automation rule.

Create an Automation rule with schedule, HTTP POST, and On-call incident triggers.

API: POST /safari/automation/rule/create (automation-rule-write-create).

func (*AutomationsService) RuleWriteDelete added in v0.5.4 

func (s *AutomationsService) RuleWriteDelete(ctx context.Context, req *AutomationRuleIDRequest) (*any, *Response, error)

Delete Automation rule.

Delete an Automation rule.

API: POST /safari/automation/rule/delete (automation-rule-write-delete).

func (*AutomationsService) RuleWriteRun added in v0.5.7 

func (s *AutomationsService) RuleWriteRun(ctx context.Context, req *AutomationRuleIDRequest) (*ManualRunRuleResult, *Response, error)

Run Automation rule.

Manually run an Automation rule immediately, outside its schedule.

API: POST /safari/automation/rule/run (automation-rule-write-run).

func (*AutomationsService) RuleWriteUpdate added in v0.5.4 

func (s *AutomationsService) RuleWriteUpdate(ctx context.Context, req *AutomationRuleUpdateRequest) (*AutomationRuleItem, *Response, error)

Update Automation rule.

Update mutable Automation rule fields, including HTTP POST and On-call incident trigger settings.

API: POST /safari/automation/rule/update (automation-rule-write-update).

func (*AutomationsService) RunReadList added in v0.5.4 

func (s *AutomationsService) RunReadList(ctx context.Context, req *AutomationRunListRequest) (*AutomationRunListResponse, *Response, error)

List Automation runs.

List run history for a rule the caller can manage.

API: POST /safari/automation/run/list (automation-run-read-list).

func (*AutomationsService) TemplateReadList added in v0.5.4 

func (s *AutomationsService) TemplateReadList(ctx context.Context, req *AutomationTemplateListRequest) (*AutomationTemplateListResponse, *Response, error)

List Automation templates.

List preset Automation templates for the requested locale.

API: POST /safari/automation/template/list (automation-template-read-list).

func (*AutomationsService) TriggerWriteFire added in v0.5.4 

func (s *AutomationsService) TriggerWriteFire(ctx context.Context, triggerID, token string, req *AutomationFireAPITriggerRequest) (*AutomationFireAPITriggerResponse, *Response, error)

TriggerWriteFire triggers an Automation run through its HTTP POST trigger URL.

This endpoint authenticates with the trigger's one-time bearer token rather than the account app_key used by the generated API methods.

API: POST /safari/automation/triggers/{trigger_id}/fire (automation-trigger-write-fire).

type BindWorkItemPostMortemRequest added in v0.8.0 

type BindWorkItemPostMortemRequest struct {
	// Client-generated idempotency key (max 128 characters; letters, digits, `_`, `-`, `.`, `:` only).
	IdempotencyKey string `json:"idempotency_key" toon:"idempotency_key"`
	// Incident ID (MongoDB ObjectID) whose converted-but-unbound follow-ups are bound.
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Post-mortem ID (32-character hex string) to bind the follow-ups to.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
}

BindWorkItemPostMortemRequest is generated from the Flashduty OpenAPI schema.

type CalEventIDRequest 

type CalEventIDRequest struct {
	// Calendar ID; obtain it from `POST /calendar/list`.
	CalID string `json:"cal_id" toon:"cal_id"`
	// Event ID.
	EventID string `json:"event_id" toon:"event_id"`
}

CalEventIDRequest is generated from the Flashduty OpenAPI schema.

type CalEventItem 

type CalEventItem struct {
	// Account ID. Only present for private events.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Calendar ID. For public events this is a locale key such as zh-cn.china.official.
	CalID string `json:"cal_id" toon:"cal_id"`
	// Creation timestamp (Unix seconds).
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Creator person ID. Only present for private events.
	CreatorID uint64 `json:"creator_id" toon:"creator_id"`
	// Event description.
	Description string `json:"description" toon:"description"`
	// Event end date (YYYY-MM-DD, exclusive).
	EndAt string `json:"end_at" toon:"end_at"`
	// Event ID.
	EventID string `json:"event_id" toon:"event_id"`
	// Whether the event marks a non-working day.
	IsOff bool `json:"is_off" toon:"is_off"`
	// Event start date (YYYY-MM-DD).
	StartAt string `json:"start_at" toon:"start_at"`
	// Event summary.
	Summary string `json:"summary" toon:"summary"`
	// Last update timestamp (Unix seconds).
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

CalEventItem is generated from the Flashduty OpenAPI schema.

type CalEventListRequest 

type CalEventListRequest struct {
	// Calendar ID; obtain it from `POST /calendar/list`.
	CalID string `json:"cal_id" toon:"cal_id"`
	// Day (1-31). 0 means no day filter.
	Day int64 `json:"day,omitempty" toon:"day,omitempty"`
	// Month (1-12). 0 means no month filter.
	Month int64 `json:"month,omitempty" toon:"month,omitempty"`
	// Year. Defaults to the current year when omitted.
	Year int64 `json:"year,omitempty" toon:"year,omitempty"`
}

CalEventListRequest is generated from the Flashduty OpenAPI schema.

type CalEventListResponse 

type CalEventListResponse struct {
	// Calendar events sorted by start_at.
	Items []CalEventItem `json:"items" toon:"items"`
	// Total number of events returned.
	Total int64 `json:"total" toon:"total"`
}

CalEventListResponse is generated from the Flashduty OpenAPI schema.

type CalEventUpsertRequest 

type CalEventUpsertRequest struct {
	// Calendar ID; obtain it from `POST /calendar/list`.
	CalID string `json:"cal_id" toon:"cal_id"`
	// Event description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Event end date in YYYY-MM-DD (exclusive).
	EndAt string `json:"end_at" toon:"end_at"`
	// Event ID. Omit when creating.
	EventID string `json:"event_id,omitempty" toon:"event_id,omitempty"`
	// Whether the event marks a non-working day. true = day off, false = working day override.
	IsOff bool `json:"is_off" toon:"is_off"`
	// Event start date in YYYY-MM-DD.
	StartAt string `json:"start_at" toon:"start_at"`
	// Event summary.
	Summary string `json:"summary" toon:"summary"`
}

CalEventUpsertRequest is generated from the Flashduty OpenAPI schema.

type CalEventUpsertResponse 

type CalEventUpsertResponse struct {
	// Calendar ID.
	CalID string `json:"cal_id" toon:"cal_id"`
	// Event ID (existing or newly generated).
	EventID string `json:"event_id" toon:"event_id"`
	// Event summary.
	Summary string `json:"summary" toon:"summary"`
}

CalEventUpsertResponse is generated from the Flashduty OpenAPI schema.

type CalendarCreateRequest 

type CalendarCreateRequest struct {
	// Calendar display name.
	CalName string `json:"cal_name" toon:"cal_name"`
	// Calendar description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Additional public-holiday calendar IDs to inherit events from (for example zh-cn.china.official).
	ExtraCalIDs []string `json:"extra_cal_ids,omitempty" toon:"extra_cal_ids,omitempty"`
	// Owning team ID. 0 means no team.
	TeamID uint64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// IANA timezone. Defaults to Asia/Shanghai when empty.
	Timezone string `json:"timezone,omitempty" toon:"timezone,omitempty"`
	// Workday numbers (0 = Sunday, 6 = Saturday).
	Workdays []int64 `json:"workdays,omitempty" toon:"workdays,omitempty"`
}

CalendarCreateRequest is generated from the Flashduty OpenAPI schema.

type CalendarCreateResponse 

type CalendarCreateResponse struct {
	// ID of the newly created calendar (format cal.<uuid>).
	CalID string `json:"cal_id" toon:"cal_id"`
	// Calendar display name.
	CalName string `json:"cal_name" toon:"cal_name"`
}

CalendarCreateResponse is generated from the Flashduty OpenAPI schema.

type CalendarEmptyObject 

type CalendarEmptyObject struct{}

CalendarEmptyObject is generated from the Flashduty OpenAPI schema.

type CalendarIDRequest 

type CalendarIDRequest struct {
	// Calendar ID; obtain it from `POST /calendar/list`.
	CalID string `json:"cal_id" toon:"cal_id"`
}

CalendarIDRequest is generated from the Flashduty OpenAPI schema.

type CalendarItem 

type CalendarItem struct {
	// Account ID.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Calendar ID.
	CalID string `json:"cal_id" toon:"cal_id"`
	// Calendar display name.
	CalName string `json:"cal_name" toon:"cal_name"`
	// Creation timestamp (Unix seconds).
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Creator person ID.
	CreatorID uint64 `json:"creator_id" toon:"creator_id"`
	// Calendar description.
	Description string `json:"description" toon:"description"`
	// Inherited public-holiday calendar IDs. Omitted when empty.
	ExtraCalIDs []string `json:"extra_cal_ids" toon:"extra_cal_ids"`
	// Calendar kind. `region.official.holiday` is a public regional holiday calendar (served by the central holiday service), `religion.holiday` is a public religious holiday calendar (reserved, currently no data), and `personal` is an account-created personal/team calendar.
	Kind string `json:"kind" toon:"kind"`
	// Calendar status. `enabled` means usable; `deleted` means removed and never returned by list endpoints.
	Status string `json:"status" toon:"status"`
	// Owning team ID (0 when not assigned).
	TeamID uint64 `json:"team_id" toon:"team_id"`
	// IANA timezone.
	Timezone string `json:"timezone" toon:"timezone"`
	// Last update timestamp (Unix seconds).
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Last updater person ID.
	UpdatedBy uint64 `json:"updated_by" toon:"updated_by"`
	// Workday numbers (0 = Sunday, 6 = Saturday). Omitted when empty.
	Workdays []int64 `json:"workdays" toon:"workdays"`
}

CalendarItem is generated from the Flashduty OpenAPI schema.

type CalendarListRequest 

type CalendarListRequest struct {
	// Calendar kind filter; defaults to personal when empty. `region.official.holiday` queries public regional holiday calendars (filtered by the caller's locale); `personal` queries account-created calendars.
	Kind string `json:"kind,omitempty" toon:"kind,omitempty"`
	// Disable locale filtering when listing public-holiday calendars.
	NoLocale bool `json:"no_locale,omitempty" toon:"no_locale,omitempty"`
}

CalendarListRequest is generated from the Flashduty OpenAPI schema.

type CalendarListResponse 

type CalendarListResponse struct {
	// Calendar items.
	Items []CalendarItem `json:"items" toon:"items"`
	// Total number of calendars returned.
	Total int64 `json:"total" toon:"total"`
}

CalendarListResponse is generated from the Flashduty OpenAPI schema.

type CalendarUpdateRequest 

type CalendarUpdateRequest struct {
	// Calendar ID; obtain it from `POST /calendar/list`.
	CalID string `json:"cal_id" toon:"cal_id"`
	// New calendar name.
	CalName *string `json:"cal_name,omitempty" toon:"cal_name,omitempty"`
	// New description.
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// Additional public-holiday calendar IDs to inherit events from.
	ExtraCalIDs []string `json:"extra_cal_ids,omitempty" toon:"extra_cal_ids,omitempty"`
	// New owning team ID; obtain it from `POST /team/list`.
	TeamID *uint64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// New IANA timezone.
	Timezone *string `json:"timezone,omitempty" toon:"timezone,omitempty"`
	// Workday numbers (0 = Sunday, 6 = Saturday).
	Workdays []int64 `json:"workdays,omitempty" toon:"workdays,omitempty"`
}

CalendarUpdateRequest is generated from the Flashduty OpenAPI schema.

type CalendarsService 

type CalendarsService service

CalendarsService handles the "On-call/Calendars" API resource.

func (*CalendarsService) CalEventDelete 

func (s *CalendarsService) CalEventDelete(ctx context.Context, req *CalEventIDRequest) (*Response, error)

Delete calendar event.

Delete a calendar event by calendar ID and event ID.

API: POST /calendar/event/delete (calEventDelete).

func (*CalendarsService) CalEventList 

func (s *CalendarsService) CalEventList(ctx context.Context, req *CalEventListRequest) (*CalEventListResponse, *Response, error)

List calendar events.

Return events for a personal calendar within a year/month/day scope. When month and day are both omitted the whole year is returned.

API: POST /calendar/event/list (calEventList).

func (*CalendarsService) CalEventUpsert 

func (s *CalendarsService) CalEventUpsert(ctx context.Context, req *CalEventUpsertRequest) (*CalEventUpsertResponse, *Response, error)

Upsert calendar event.

Create or update a calendar event (holiday or workday override). Omit event_id to create a new event.

API: POST /calendar/event/upsert (calEventUpsert).

func (*CalendarsService) CalendarCreate 

func (s *CalendarsService) CalendarCreate(ctx context.Context, req *CalendarCreateRequest) (*CalendarCreateResponse, *Response, error)

Create calendar.

Create a personal service calendar. Each account is limited to 5 calendars unless the Flashcat-Break-Cal-Limit header is set.

API: POST /calendar/create (calendarCreate).

func (*CalendarsService) CalendarDelete 

func (s *CalendarsService) CalendarDelete(ctx context.Context, req *CalendarIDRequest) (*Response, error)

Delete calendar.

Delete a personal service calendar. The call fails when referenced by escalation or silence rules.

API: POST /calendar/delete (calendarDelete).

func (*CalendarsService) CalendarInfo 

func (s *CalendarsService) CalendarInfo(ctx context.Context, req *CalendarIDRequest) (*CalendarItem, *Response, error)

Get calendar info.

Return details of a service calendar.

API: POST /calendar/info (calendarInfo).

func (*CalendarsService) CalendarList 

func (s *CalendarsService) CalendarList(ctx context.Context, req *CalendarListRequest) (*CalendarListResponse, *Response, error)

List calendars.

Return the list of service calendars visible to the current account.

API: POST /calendar/list (calendarList).

func (*CalendarsService) CalendarUpdate 

func (s *CalendarsService) CalendarUpdate(ctx context.Context, req *CalendarUpdateRequest) (*Response, error)

Update calendar.

Update a personal service calendar. Only non-null fields are updated.

API: POST /calendar/update (calendarUpdate).

type CancelStatusPageMigrationRequest 

type CancelStatusPageMigrationRequest struct {
	// Migration job ID, returned when the migration job is created; check progress via `GET /status-page/migration/status`.
	JobID string `json:"job_id" toon:"job_id"`
}

CancelStatusPageMigrationRequest is generated from the Flashduty OpenAPI schema.

type ChangeEventItem added in v0.4.0 

type ChangeEventItem struct {
	// Account this change event belongs to.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Stable key that groups events belonging to the same change.
	ChangeKey string `json:"change_key" toon:"change_key"`
	// Lifecycle status of the change event, reported by the change source as execution progresses.
	// | Value | Meaning |
	// |---|---|
	// | `Planned` | Planned, not started. |
	// | `Ready` | Ready for execution. |
	// | `Processing` | Being executed. |
	// | `Canceled` | Canceled. |
	// | `Done` | Completed. |
	ChangeStatus string `json:"change_status" toon:"change_status"`
	// Collaboration channel this change event is routed to.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Unix timestamp in seconds when the change event was created.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Unix timestamp in seconds when the change event was deleted. Omitted when not deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Change event description.
	Description string `json:"description" toon:"description"`
	// Change event ID, a MongoDB ObjectID hex string.
	EventID string `json:"event_id" toon:"event_id"`
	// Unix timestamp in seconds when the change event occurred.
	EventTime Timestamp `json:"event_time" toon:"event_time"`
	// Integration that reported this change event.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Key-value labels attached to the change event.
	Labels map[string]string `json:"labels" toon:"labels"`
	// External link to the source change record.
	Link string `json:"link" toon:"link"`
	// Change event title.
	Title string `json:"title" toon:"title"`
	// Unix timestamp in seconds when the change event was last updated.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

ChangeEventItem is generated from the Flashduty OpenAPI schema.

type ChangeItem added in v0.4.0 

type ChangeItem struct {
	// Account this change belongs to.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Change ID, a MongoDB ObjectID hex string.
	ChangeID string `json:"change_id" toon:"change_id"`
	// Stable key that groups events belonging to the same change.
	ChangeKey string `json:"change_key" toon:"change_key"`
	// Current lifecycle status of the change.
	// | Value | Meaning |
	// |---|---|
	// | `Planned` | Planned, not started. |
	// | `Ready` | Ready for execution. |
	// | `Processing` | Being executed. |
	// | `Canceled` | Canceled. |
	// | `Done` | Completed. |
	ChangeStatus string `json:"change_status" toon:"change_status"`
	// Collaboration channel this change is routed to.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Name of the collaboration channel.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Status of the collaboration channel: `enabled` or `disabled`.
	ChannelStatus string `json:"channel_status" toon:"channel_status"`
	// Change description.
	Description string `json:"description" toon:"description"`
	// Unix timestamp in seconds when the change ended.
	EndTime Timestamp `json:"end_time" toon:"end_time"`
	// Underlying change events, returned only when include_events is true.
	Events []ChangeEventItem `json:"events" toon:"events"`
	// Integration that reported this change.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Name of the reporting integration.
	IntegrationName string `json:"integration_name" toon:"integration_name"`
	// Key-value labels attached to the change.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Unix timestamp in seconds of the most recent change activity.
	LastTime Timestamp `json:"last_time" toon:"last_time"`
	// External link to the source change record.
	Link string `json:"link" toon:"link"`
	// Unix timestamp in seconds when the change started.
	StartTime Timestamp `json:"start_time" toon:"start_time"`
	// Change title.
	Title string `json:"title" toon:"title"`
}

ChangeItem is generated from the Flashduty OpenAPI schema.

type ChangesService added in v0.4.0 

type ChangesService service

ChangesService handles the "On-call/Changes" API resource.

func (*ChangesService) List added in v0.4.0 

func (s *ChangesService) List(ctx context.Context, req *ListChangeRequest) (*ListChangeResponse, *Response, error)

List changes.

Query change records within a time window, with filtering, search, and pagination.

API: POST /change/list (change-read-list).

type ChannelCreateResponse 

type ChannelCreateResponse struct {
	// Newly created channel ID.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel name echoed back from the request.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// External report token. Emitted only when external reporting is enabled.
	ExternalReportToken string `json:"external_report_token" toon:"external_report_token"`
}

ChannelCreateResponse is generated from the Flashduty OpenAPI schema.

type ChannelIDRequest 

type ChannelIDRequest struct {
	// Channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
}

ChannelIDRequest is generated from the Flashduty OpenAPI schema.

type ChannelInfoRequest 

type ChannelInfoRequest struct {
	// ID of the channel to query; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
}

ChannelInfoRequest is generated from the Flashduty OpenAPI schema.

type ChannelInfosRequest 

type ChannelInfosRequest struct {
	// Channel IDs to look up. Up to 1000.
	ChannelIDs []int64 `json:"channel_ids" toon:"channel_ids"`
}

ChannelInfosRequest is generated from the Flashduty OpenAPI schema.

type ChannelInfosResponse 

type ChannelInfosResponse struct {
	// Brief info for the requested `channel_ids` that actually exist; IDs not found are ignored.
	Items []ChannelShort `json:"items" toon:"items"`
}

ChannelInfosResponse is generated from the Flashduty OpenAPI schema.

type ChannelItem 

type ChannelItem struct {
	// Owning account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Highest severity among the channel's active (triggered or processing) incidents: `Critical`, `Warning` or `Info`. Omitted when there are no active incidents.
	ActiveIncidentHighestSeverity string `json:"active_incident_highest_severity" toon:"active_incident_highest_severity"`
	// How the auto-resolve timer is reset. `trigger` (default) starts the timer once when the incident is triggered — later merged alerts do not affect it; `update` restarts the timer from the latest alert time whenever a new alert merges into the incident.
	AutoResolveMode string `json:"auto_resolve_mode" toon:"auto_resolve_mode"`
	// Auto-resolve timeout in seconds. 0 disables auto-resolve.
	AutoResolveTimeout int64 `json:"auto_resolve_timeout" toon:"auto_resolve_timeout"`
	// Channel ID.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel name.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Creation time, Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Member ID who created the channel.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Name of the member who created the channel (resolved from the member directory; empty when unavailable).
	CreatorName string `json:"creator_name" toon:"creator_name"`
	// Deletion time, Unix timestamp in seconds. Non-zero only for soft-deleted channels.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Free-form description.
	Description string `json:"description" toon:"description"`
	// When true, automatic incident closing is disabled.
	DisableAutoClose bool `json:"disable_auto_close" toon:"disable_auto_close"`
	// When true, outlier incident detection is disabled.
	DisableOutlierDetection bool `json:"disable_outlier_detection" toon:"disable_outlier_detection"`
	// Alert event merge configuration.
	EventGroup EventGroup `json:"event_group" toon:"event_group"`
	// Token granted to external reporters. Omitted unless external reporting is enabled on the channel.
	ExternalReportToken string `json:"external_report_token" toon:"external_report_token"`
	// Flapping detection configuration.
	Flapping Flapping `json:"flapping" toon:"flapping"`
	// Alert grouping configuration.
	Group Group `json:"group" toon:"group"`
	// Whether external reporters can file incidents into this channel.
	IsExternalReportEnabled bool `json:"is_external_report_enabled" toon:"is_external_report_enabled"`
	// When true, the channel is visible only to its managing teams.
	IsPrivate bool `json:"is_private" toon:"is_private"`
	// Whether the current user has starred this channel. Present only in `POST /channel/list` responses.
	IsStarred bool `json:"is_starred" toon:"is_starred"`
	// Time of the most recent incident, Unix timestamp in seconds.
	LastIncidentAt Timestamp `json:"last_incident_at" toon:"last_incident_at"`
	// Additional teams that can manage the channel.
	ManagingTeamIDs []int64 `json:"managing_team_ids" toon:"managing_team_ids"`
	// Incident counts by progress over the last 30 days.
	ProgressToIncidentCnts IncProgressCnts `json:"progress_to_incident_cnts" toon:"progress_to_incident_cnts"`
	// Channel status. `enabled` receives and processes events normally; `disabled` drops incoming events outright; `deleted` is returned only when fetching a channel by ID — list endpoints never return it.
	Status string `json:"status" toon:"status"`
	// Owning team ID.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Owning team name (resolved from the team directory; empty when unavailable).
	TeamName string `json:"team_name" toon:"team_name"`
	// Last update time, Unix timestamp in seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

ChannelItem is generated from the Flashduty OpenAPI schema.

type ChannelRuleIDRequest 

type ChannelRuleIDRequest struct {
	// Owning channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
}

ChannelRuleIDRequest is generated from the Flashduty OpenAPI schema.

type ChannelScopedListRequest 

type ChannelScopedListRequest struct {
	// Channel to list rules for.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
}

ChannelScopedListRequest is generated from the Flashduty OpenAPI schema.

type ChannelShort 

type ChannelShort struct {
	// Channel ID.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel name.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Channel status: `enabled` processes events normally; `disabled` discards incoming events; `deleted` is soft-deleted.
	Status string `json:"status" toon:"status"`
}

ChannelShort is generated from the Flashduty OpenAPI schema.

type ChannelsService 

type ChannelsService service

ChannelsService handles the "On-call/Channels" API resource.

func (*ChannelsService) ChannelCreate 

func (s *ChannelsService) ChannelCreate(ctx context.Context, req *CreateChannelRequest) (*ChannelCreateResponse, *Response, error)

Create channel.

Create a new channel for incident management.

API: POST /channel/create (channelCreate).

func (*ChannelsService) ChannelDelete 

func (s *ChannelsService) ChannelDelete(ctx context.Context, req *ChannelIDRequest) (*Response, error)

Delete channel.

Delete a channel. Only a `disabled` channel can be deleted; all of its escalation, silence, drop and inhibit rules are deleted with it. The call fails when an integration route still references the channel.

API: POST /channel/delete (channelDelete).

func (*ChannelsService) ChannelDisable 

func (s *ChannelsService) ChannelDisable(ctx context.Context, req *ChannelIDRequest) (*Response, error)

Disable channel.

Disable a channel to stop incident routing without deleting it; a disabled channel discards incoming events. Only an `enabled` channel can be disabled.

API: POST /channel/disable (channelDisable).

func (*ChannelsService) ChannelEnable 

func (s *ChannelsService) ChannelEnable(ctx context.Context, req *ChannelIDRequest) (*Response, error)

Enable channel.

Enable a channel to resume incident routing. Only a `disabled` channel can be enabled.

API: POST /channel/enable (channelEnable).

func (*ChannelsService) ChannelEscalateRuleCreate 

func (s *ChannelsService) ChannelEscalateRuleCreate(ctx context.Context, req *CreateEscalationRuleRequest) (*RuleCreateResponse, *Response, error)

Create escalation rule.

Create an escalation rule defining who gets notified and when during an incident.

API: POST /channel/escalate/rule/create (channelEscalateRuleCreate).

func (*ChannelsService) ChannelEscalateRuleDelete 

func (s *ChannelsService) ChannelEscalateRuleDelete(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Delete escalation rule.

Delete an escalation rule. Only a `disabled` rule can be deleted.

API: POST /channel/escalate/rule/delete (channelEscalateRuleDelete).

func (*ChannelsService) ChannelEscalateRuleDisable 

func (s *ChannelsService) ChannelEscalateRuleDisable(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Disable escalation rule.

Disable an escalation rule without deleting it. Only an `enabled` rule can be disabled.

API: POST /channel/escalate/rule/disable (channelEscalateRuleDisable).

func (*ChannelsService) ChannelEscalateRuleEnable 

func (s *ChannelsService) ChannelEscalateRuleEnable(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Enable escalation rule.

Enable a disabled escalation rule. Only a `disabled` rule can be enabled.

API: POST /channel/escalate/rule/enable (channelEscalateRuleEnable).

func (*ChannelsService) ChannelEscalateRuleInfo 

func (s *ChannelsService) ChannelEscalateRuleInfo(ctx context.Context, req *ChannelRuleIDRequest) (*EscalateRuleItem, *Response, error)

Get escalation rule detail.

Retrieve detailed information for a specific escalation rule.

API: POST /channel/escalate/rule/info (channelEscalateRuleInfo).

func (*ChannelsService) ChannelEscalateRuleList 

func (s *ChannelsService) ChannelEscalateRuleList(ctx context.Context, req *ChannelScopedListRequest) (*ListEscalationRulesResponse, *Response, error)

List escalation rules.

List all escalation rules for a channel.

API: POST /channel/escalate/rule/list (channelEscalateRuleList).

func (*ChannelsService) ChannelEscalateRuleUpdate 

func (s *ChannelsService) ChannelEscalateRuleUpdate(ctx context.Context, req *UpdateEscalationRuleRequest) (*Response, error)

Update escalation rule.

Update an existing escalation rule configuration.

API: POST /channel/escalate/rule/update (channelEscalateRuleUpdate).

func (*ChannelsService) ChannelInfo 

func (s *ChannelsService) ChannelInfo(ctx context.Context, req *ChannelInfoRequest) (*ChannelItem, *Response, error)

Get channel detail.

Retrieve detailed information for a specific channel.

API: POST /channel/info (channelInfo).

func (*ChannelsService) ChannelInfos 

func (s *ChannelsService) ChannelInfos(ctx context.Context, req *ChannelInfosRequest) (*ChannelInfosResponse, *Response, error)

Batch get channels.

Retrieve multiple channels by their IDs.

API: POST /channel/infos (channelInfos).

func (*ChannelsService) ChannelInhibitRuleCreate 

func (s *ChannelsService) ChannelInhibitRuleCreate(ctx context.Context, req *CreateInhibitRuleRequest) (*RuleCreateResponse, *Response, error)

Create inhibit rule.

Create an inhibit rule to suppress lower-priority alerts when higher-priority ones are firing.

API: POST /channel/inhibit/rule/create (channelInhibitRuleCreate).

func (*ChannelsService) ChannelInhibitRuleDelete 

func (s *ChannelsService) ChannelInhibitRuleDelete(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Delete inhibit rule.

Delete an inhibit rule. Only a `disabled` rule can be deleted.

API: POST /channel/inhibit/rule/delete (channelInhibitRuleDelete).

func (*ChannelsService) ChannelInhibitRuleDisable 

func (s *ChannelsService) ChannelInhibitRuleDisable(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Disable inhibit rule.

Disable an inhibit rule without deleting it. Only an `enabled` rule can be disabled.

API: POST /channel/inhibit/rule/disable (channelInhibitRuleDisable).

func (*ChannelsService) ChannelInhibitRuleEnable 

func (s *ChannelsService) ChannelInhibitRuleEnable(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Enable inhibit rule.

Enable a disabled inhibit rule. Only a `disabled` rule can be enabled.

API: POST /channel/inhibit/rule/enable (channelInhibitRuleEnable).

func (*ChannelsService) ChannelInhibitRuleList 

func (s *ChannelsService) ChannelInhibitRuleList(ctx context.Context, req *ChannelScopedListRequest) (*ListInhibitRulesResponse, *Response, error)

List inhibit rules.

List all inhibit rules configured for a channel.

API: POST /channel/inhibit/rule/list (channelInhibitRuleList).

func (*ChannelsService) ChannelInhibitRuleUpdate 

func (s *ChannelsService) ChannelInhibitRuleUpdate(ctx context.Context, req *UpdateInhibitRuleRequest) (*Response, error)

Update inhibit rule.

Update an existing inhibit rule configuration.

API: POST /channel/inhibit/rule/update (channelInhibitRuleUpdate).

func (*ChannelsService) ChannelList 

func (s *ChannelsService) ChannelList(ctx context.Context, req *ListChannelsRequest) (*ListChannelsResponse, *Response, error)

List channels.

List channels accessible to the current user with optional filters.

API: POST /channel/list (channelList).

func (*ChannelsService) ChannelSilenceRuleCreate 

func (s *ChannelsService) ChannelSilenceRuleCreate(ctx context.Context, req *CreateSilenceRuleRequest) (*RuleCreateResponse, *Response, error)

Create silence rule.

Create a silence rule to suppress notifications matching specified conditions.

API: POST /channel/silence/rule/create (channelSilenceRuleCreate).

func (*ChannelsService) ChannelSilenceRuleDelete 

func (s *ChannelsService) ChannelSilenceRuleDelete(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Delete silence rule.

Delete a silence rule. Only a `disabled` rule can be deleted.

API: POST /channel/silence/rule/delete (channelSilenceRuleDelete).

func (*ChannelsService) ChannelSilenceRuleDisable 

func (s *ChannelsService) ChannelSilenceRuleDisable(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Disable silence rule.

Disable a silence rule without deleting it. Only an `enabled` rule can be disabled.

API: POST /channel/silence/rule/disable (channelSilenceRuleDisable).

func (*ChannelsService) ChannelSilenceRuleEnable 

func (s *ChannelsService) ChannelSilenceRuleEnable(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Enable silence rule.

Enable a disabled silence rule. Only a `disabled` rule can be enabled.

API: POST /channel/silence/rule/enable (channelSilenceRuleEnable).

func (*ChannelsService) ChannelSilenceRuleList 

func (s *ChannelsService) ChannelSilenceRuleList(ctx context.Context, req *ChannelScopedListRequest) (*ListSilenceRulesResponse, *Response, error)

List silence rules.

List all silence rules configured for a channel.

API: POST /channel/silence/rule/list (channelSilenceRuleList).

func (*ChannelsService) ChannelSilenceRuleUpdate 

func (s *ChannelsService) ChannelSilenceRuleUpdate(ctx context.Context, req *UpdateSilenceRuleRequest) (*Response, error)

Update silence rule.

Update an existing silence rule configuration.

API: POST /channel/silence/rule/update (channelSilenceRuleUpdate).

func (*ChannelsService) ChannelUnsubscribeRuleCreate 

func (s *ChannelsService) ChannelUnsubscribeRuleCreate(ctx context.Context, req *CreateDropRuleRequest) (*RuleCreateResponse, *Response, error)

Create drop rule.

Create a drop rule to filter out unwanted alerts before they become incidents.

API: POST /channel/unsubscribe/rule/create (channelUnsubscribeRuleCreate).

func (*ChannelsService) ChannelUnsubscribeRuleDelete 

func (s *ChannelsService) ChannelUnsubscribeRuleDelete(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Delete drop rule.

Delete a drop rule. Only a `disabled` rule can be deleted.

API: POST /channel/unsubscribe/rule/delete (channelUnsubscribeRuleDelete).

func (*ChannelsService) ChannelUnsubscribeRuleDisable 

func (s *ChannelsService) ChannelUnsubscribeRuleDisable(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Disable drop rule.

Disable a drop rule without deleting it. Only an `enabled` rule can be disabled.

API: POST /channel/unsubscribe/rule/disable (channelUnsubscribeRuleDisable).

func (*ChannelsService) ChannelUnsubscribeRuleEnable 

func (s *ChannelsService) ChannelUnsubscribeRuleEnable(ctx context.Context, req *ChannelRuleIDRequest) (*Response, error)

Enable drop rule.

Enable a disabled drop rule. Only a `disabled` rule can be enabled.

API: POST /channel/unsubscribe/rule/enable (channelUnsubscribeRuleEnable).

func (*ChannelsService) ChannelUnsubscribeRuleList 

func (s *ChannelsService) ChannelUnsubscribeRuleList(ctx context.Context, req *ChannelScopedListRequest) (*ListDropRulesResponse, *Response, error)

List drop rules.

List drop rules for a channel.

API: POST /channel/unsubscribe/rule/list (channelUnsubscribeRuleList).

func (*ChannelsService) ChannelUnsubscribeRuleUpdate 

func (s *ChannelsService) ChannelUnsubscribeRuleUpdate(ctx context.Context, req *UpdateDropRuleRequest) (*Response, error)

Update drop rule.

Update an existing drop rule configuration.

API: POST /channel/unsubscribe/rule/update (channelUnsubscribeRuleUpdate).

func (*ChannelsService) ChannelUpdate 

func (s *ChannelsService) ChannelUpdate(ctx context.Context, req *UpdateChannelRequest) (*UpdateChannelResponse, *Response, error)

Update channel.

Update an existing channel's configuration and settings.

API: POST /channel/update (channelUpdate).

func (*ChannelsService) RouteInfo 

func (s *ChannelsService) RouteInfo(ctx context.Context, req *RouteInfoRequest) (*RouteItem, *Response, error)

Get routing rule detail.

Retrieve the routing rule configuration for a specific integration. Returns null when the integration has no routing rule configured.

API: POST /route/info (routeInfo).

func (*ChannelsService) RouteList 

func (s *ChannelsService) RouteList(ctx context.Context, req *ListRoutesRequest) (*ListRoutesResponse, *Response, error)

List routing rules.

Return routing rules for the specified integrations. Integrations without a configured rule are omitted from the response.

API: POST /route/list (routeList).

func (*ChannelsService) RouteUpsert 

func (s *ChannelsService) RouteUpsert(ctx context.Context, req *UpsertRouteRequest) (*Response, error)

Upsert routing rule.

Create or update routing rules for an integration to direct alerts to specific channels. At least one of `cases` or `default` must be provided.

API: POST /route/upsert (routeUpsert).

type Client 

type Client struct {
	BaseURL   *url.URL
	UserAgent string
	// contains filtered or unexported fields
}

Client is a Flashduty Open API client. Construct it with NewClient and use the service fields (added by the generator) to call endpoints.

Example (ErrorHandling)

ExampleClient_errorHandling distinguishes API errors from rate-limit errors. 

package main

import (
	"context"
	"errors"
	"fmt"
	"log"
	"time"

	flashduty "github.com/flashcatcloud/go-flashduty"
)

func main() {
	ctx := context.Background()

	client, err := flashduty.NewClient("YOUR_APP_KEY")
	if err != nil {
		log.Fatal(err)
	}

	_, _, err = client.Incidents.Info(ctx, &flashduty.IncidentInfoRequest{
		IncidentID: "does-not-exist",
	})

	var rl *flashduty.RateLimitError
	if errors.As(err, &rl) {
		// Back off for the duration the server asked for, then retry.
		time.Sleep(rl.RetryAfter)
		return
	}

	var apiErr *flashduty.ErrorResponse
	if errors.As(err, &apiErr) {
		fmt.Printf("api error code=%s request_id=%s\n", apiErr.Code, apiErr.RequestID)
		return
	}

	if err != nil {
		log.Fatal(err)
	}
}

func NewClient 

func NewClient(appKey string, opts ...Option) (*Client, error)

NewClient returns a Flashduty client authenticated with the given app key.

Example

ExampleNewClient shows how to construct a client with a couple of options. 

package main

import (
	"fmt"
	"log"
	"time"

	flashduty "github.com/flashcatcloud/go-flashduty"
)

func main() {
	client, err := flashduty.NewClient(
		"YOUR_APP_KEY",
		flashduty.WithTimeout(30*time.Second),
		flashduty.WithUserAgent("my-app/1.0"),
	)
	if err != nil {
		log.Fatal(err)
	}
	_ = client

	fmt.Println("client ready")
}

type CommentIncidentRequest 

type CommentIncidentRequest struct {
	// Comment body. Leading and trailing whitespace is trimmed; the comment must be non-empty after trimming and at most 1024 characters (counted after @mention normalization).
	Comment string `json:"comment" toon:"comment"`
	// Optional ID of an account-level comment type to attach to the comment (MongoDB ObjectID). An invalid or all-zero ID is rejected with 400.
	CommentTypeID *string `json:"comment_type_id,omitempty" toon:"comment_type_id,omitempty"`
	// Incident IDs to comment on. At most 100 per call.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
	// When true, do not trigger webhook reply actions for this comment.
	MuteReply bool `json:"mute_reply,omitempty" toon:"mute_reply,omitempty"`
}

CommentIncidentRequest is generated from the Flashduty OpenAPI schema.

type CompleteWorkItemRequest added in v0.8.0 

type CompleteWorkItemRequest struct {
	// Client-generated idempotency key (max 128 characters; letters, digits, `_`, `-`, `.`, `:` only).
	IdempotencyKey string `json:"idempotency_key" toon:"idempotency_key"`
	// Client-defined status to set (max 64 characters). There is no fixed state machine.
	TargetStatus string `json:"target_status" toon:"target_status"`
	// Current item version for optimistic locking. Must match the stored version.
	Version int64 `json:"version" toon:"version"`
	// Work item ID (opaque string, max 128 characters).
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

CompleteWorkItemRequest is generated from the Flashduty OpenAPI schema.

type ContextResolvedItem added in v0.5.4 

type ContextResolvedItem struct {
	// Resolved account-scoped pack id.
	AccountPackID string `json:"account_pack_id" toon:"account_pack_id"`
	// Bound incident id, when war-room originated.
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Unix timestamp in milliseconds when the packs were resolved.
	ResolvedAtMs TimestampMilli `json:"resolved_at_ms" toon:"resolved_at_ms"`
	// Resolved team-scoped pack id.
	TeamPackID string `json:"team_pack_id" toon:"team_pack_id"`
	// Per-pack resolved version map.
	Versions map[string]int64 `json:"versions" toon:"versions"`
}

ContextResolvedItem is generated from the Flashduty OpenAPI schema.

type ConvertWorkItemRequest added in v0.8.0 

type ConvertWorkItemRequest struct {
	// Client-generated idempotency key (max 128 characters; letters, digits, `_`, `-`, `.`, `:` only).
	IdempotencyKey string `json:"idempotency_key" toon:"idempotency_key"`
	// Optional client-defined status to set on the converted follow-up (max 64 characters).
	TargetStatus *string `json:"target_status,omitempty" toon:"target_status,omitempty"`
	// Current item version for optimistic locking. Must match the stored version.
	Version int64 `json:"version" toon:"version"`
	// Work item ID (opaque string, max 128 characters).
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

ConvertWorkItemRequest is generated from the Flashduty OpenAPI schema.

type CreateChannelRequest 

type CreateChannelRequest struct {
	// Auto-resolve timing mode: `trigger` starts the timer when the incident triggers, `update` restarts it on every alert update.
	AutoResolveMode string `json:"auto_resolve_mode,omitempty" toon:"auto_resolve_mode,omitempty"`
	// Auto-resolve timeout in seconds. 0 disables auto-resolve. Max 30 days.
	AutoResolveTimeout int64 `json:"auto_resolve_timeout,omitempty" toon:"auto_resolve_timeout,omitempty"`
	// Channel name. 1 to 59 characters.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Free-form description. Up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Disable automatic incident closing.
	DisableAutoClose bool `json:"disable_auto_close,omitempty" toon:"disable_auto_close,omitempty"`
	// Disable outlier incident detection.
	DisableOutlierDetection bool `json:"disable_outlier_detection,omitempty" toon:"disable_outlier_detection,omitempty"`
	// Default escalation rule applied to the channel. Omit to skip default escalation.
	EscalateRule CreateChannelRequestEscalateRule `json:"escalate_rule,omitzero" toon:"escalate_rule,omitempty"`
	// Alert event merge configuration. Omit to use the default (merge enabled, 1440-minute window).
	EventGroup EventGroup `json:"event_group,omitzero" toon:"event_group,omitempty"`
	// Flapping detection configuration.
	Flapping CreateChannelRequestFlapping `json:"flapping,omitzero" toon:"flapping,omitempty"`
	// Alert grouping configuration.
	Group CreateChannelRequestGroup `json:"group,omitzero" toon:"group,omitempty"`
	// Allow external reporters to file incidents into this channel.
	IsExternalReportEnabled bool `json:"is_external_report_enabled,omitempty" toon:"is_external_report_enabled,omitempty"`
	// When true, the channel is visible only to its managing teams.
	IsPrivate bool `json:"is_private,omitempty" toon:"is_private,omitempty"`
	// Additional teams that can manage the channel. Up to 3 entries.
	ManagingTeamIDs []int64 `json:"managing_team_ids,omitempty" toon:"managing_team_ids,omitempty"`
	// IDs of plugins (integrations) subscribed to this channel.
	PluginIDs []int64 `json:"plugin_ids,omitempty" toon:"plugin_ids,omitempty"`
	// Owning team ID; obtain it from `POST /team/list`.
	TeamID int64 `json:"team_id" toon:"team_id"`
}

CreateChannelRequest is generated from the Flashduty OpenAPI schema.

type CreateChannelRequestEscalateRule 

type CreateChannelRequestEscalateRule struct {
	// Delay window in seconds. 0 disables delay.
	AggrWindow int64 `json:"aggr_window,omitempty" toon:"aggr_window,omitempty"`
	// Notification target. At least one of `person_ids`, `team_ids`, `schedule_to_role_ids`, or `emails` must be set, together with either `by` or `webhooks`.
	Target CreateChannelRequestEscalateRuleTarget `json:"target" toon:"target"`
	// Notification template ID (MongoDB ObjectID).
	TemplateID string `json:"template_id" toon:"template_id"`
}

CreateChannelRequestEscalateRule is generated from the Flashduty OpenAPI schema.

type CreateChannelRequestEscalateRuleTarget 

type CreateChannelRequestEscalateRuleTarget struct {
	// Per-severity personal notification channels. Required unless `webhooks` is provided.
	By CreateChannelRequestEscalateRuleTargetBy `json:"by,omitzero" toon:"by,omitempty"`
	// Email addresses to notify (push-only scenarios).
	Emails []string `json:"emails,omitempty" toon:"emails,omitempty"`
	// Member IDs to notify directly; obtain member IDs from `POST /member/list`.
	PersonIDs []int64 `json:"person_ids,omitempty" toon:"person_ids,omitempty"`
	// Map of schedule ID to the role IDs on that schedule to notify.
	ScheduleToRoleIDs map[string][]int64 `json:"schedule_to_role_ids,omitempty" toon:"schedule_to_role_ids,omitempty"`
	// Team IDs to notify; obtain team IDs from `POST /team/list`.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
	// Group chat / webhook targets. Required unless `by` is provided.
	Webhooks []CreateChannelRequestEscalateRuleTargetWebhooksItem `json:"webhooks,omitempty" toon:"webhooks,omitempty"`
}

CreateChannelRequestEscalateRuleTarget is generated from the Flashduty OpenAPI schema.

type CreateChannelRequestEscalateRuleTargetBy 

type CreateChannelRequestEscalateRuleTargetBy struct {
	// Notify channels used for Critical severity. Personal channels: `sms`, `voice`, `email`, `push`; IM group-chat channels: `feishu_app:<chat_id>`, `dingtalk_app:<chat_id>`, `wecom_app:<chat_id>`, `slack_app:<chat_id>`, `teams_app:<chat_id>`.
	Critical []string `json:"critical,omitempty" toon:"critical,omitempty"`
	// When true, use each responder's personal preference instead of the lists below.
	FollowPreference bool `json:"follow_preference,omitempty" toon:"follow_preference,omitempty"`
	// Notify channels used for Info severity. Values as for `critical`.
	Info []string `json:"info,omitempty" toon:"info,omitempty"`
	// Notify channels used for Warning severity. Values as for `critical`.
	Warning []string `json:"warning,omitempty" toon:"warning,omitempty"`
}

CreateChannelRequestEscalateRuleTargetBy is generated from the Flashduty OpenAPI schema.

type CreateChannelRequestEscalateRuleTargetWebhooksItem 

type CreateChannelRequestEscalateRuleTargetWebhooksItem struct {
	// Type-specific settings (chat IDs, URLs, etc.).
	Settings map[string]any `json:"settings" toon:"settings"`
	// Webhook type, one of `feishu`, `feishu_app`, `dingtalk`, `dingtalk_app`, `wecom`, `slack`, `slack_app`, `teams_app`, `telegram`, `zoom`.
	Type string `json:"type" toon:"type"`
}

CreateChannelRequestEscalateRuleTargetWebhooksItem is generated from the Flashduty OpenAPI schema.

type CreateChannelRequestFlapping 

type CreateChannelRequestFlapping struct {
	// Observation window in minutes.
	InMins int64 `json:"in_mins,omitempty" toon:"in_mins,omitempty"`
	// Disable flapping detection.
	IsDisabled bool `json:"is_disabled,omitempty" toon:"is_disabled,omitempty"`
	// Max state changes allowed within `in_mins`.
	MaxChanges int64 `json:"max_changes,omitempty" toon:"max_changes,omitempty"`
	// Mute duration in minutes after flapping is detected.
	MuteMins int64 `json:"mute_mins,omitempty" toon:"mute_mins,omitempty"`
}

CreateChannelRequestFlapping is generated from the Flashduty OpenAPI schema.

type CreateChannelRequestGroup 

type CreateChannelRequestGroup struct {
	// When true, all listed keys must be present for grouping.
	AllEqualsRequired bool `json:"all_equals_required,omitempty" toon:"all_equals_required,omitempty"`
	// Per-filter grouping overrides.
	Cases []CreateChannelRequestGroupCasesItem `json:"cases,omitempty" toon:"cases,omitempty"`
	// Groups of label keys whose equality defines a bucket.
	Equals [][]string `json:"equals,omitempty" toon:"equals,omitempty"`
	// Label keys used for intelligent grouping embeddings.
	IKeys []string `json:"i_keys,omitempty" toon:"i_keys,omitempty"`
	// Intelligent grouping similarity threshold.
	IScoreThreshold float64 `json:"i_score_threshold,omitempty" toon:"i_score_threshold,omitempty"`
	// Grouping method: `i` intelligent, `p` pattern, `n` none.
	Method string `json:"method" toon:"method"`
	// Alert storm threshold.
	StormThreshold int64 `json:"storm_threshold,omitempty" toon:"storm_threshold,omitempty"`
	// Multi-level storm thresholds.
	StormThresholds []int64 `json:"storm_thresholds,omitempty" toon:"storm_thresholds,omitempty"`
	// Grouping time window in minutes. Default max is 1440 minutes (24 h); extended accounts may allow up to 43200 minutes (30 days).
	TimeWindow int64 `json:"time_window,omitempty" toon:"time_window,omitempty"`
	// Window type, default `tumbling`. `tumbling` is a fixed window counted from incident creation — once it expires, new alerts open a new incident; `sliding` is a sliding window counted from the incident's most recent alert, extended each time a new alert merges in.
	WindowType string `json:"window_type,omitempty" toon:"window_type,omitempty"`
}

CreateChannelRequestGroup is generated from the Flashduty OpenAPI schema.

type CreateChannelRequestGroupCasesItem added in v0.14.3 

type CreateChannelRequestGroupCasesItem struct {
	// Grouping keys for matching alerts. Supported values: `title`, `description`, `severity`, or any `labels.<name>`.
	Equals []string `json:"equals" toon:"equals"`
	// AND-ed match conditions evaluated against stored alert fields.
	If []FilterCondition `json:"if" toon:"if"`
}

CreateChannelRequestGroupCasesItem is generated from the Flashduty OpenAPI schema.

type CreateDropRuleRequest 

type CreateDropRuleRequest struct {
	// Owning channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Rule description, up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Alert event match conditions (OR-of-AND); matching events are discarded entirely — no alert, incident, or notification is produced. When omitted or empty, the rule matches nothing.
	Filters [][]CreateDropRuleRequestFiltersItemItem `json:"filters,omitempty" toon:"filters,omitempty"`
	// Rule name, 1 to 39 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
}

CreateDropRuleRequest is generated from the Flashduty OpenAPI schema.

type CreateDropRuleRequestFiltersItemItem 

type CreateDropRuleRequestFiltersItemItem struct {
	// Field key (e.g. `alert_severity`, `labels.service`).
	Key string `json:"key" toon:"key"`
	// Filter operator.
	Oper string `json:"oper" toon:"oper"`
	// Values to match.
	Vals []string `json:"vals" toon:"vals"`
}

CreateDropRuleRequestFiltersItemItem is generated from the Flashduty OpenAPI schema.

type CreateEscalationRuleRequest 

type CreateEscalationRuleRequest struct {
	// Delay window in seconds. 0 disables delay.
	AggrWindow int64 `json:"aggr_window,omitempty" toon:"aggr_window,omitempty"`
	// Owning channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Rule description, up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Incident-level match conditions (OR-of-AND tree): the rule is matched against the incident the alert was grouped into, not against the alert itself. Omit or leave empty to apply the rule to all incidents in the channel.
	Filters [][]CreateEscalationRuleRequestFiltersItemItem `json:"filters,omitempty" toon:"filters,omitempty"`
	// Escalation levels in order. At least one level is required.
	Layers []CreateEscalationRuleRequestLayersItem `json:"layers" toon:"layers"`
	// Evaluation priority. Lower runs first.
	Priority *int64 `json:"priority,omitempty" toon:"priority,omitempty"`
	// Rule name, 1 to 39 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Notification template ID (MongoDB ObjectID).
	TemplateID string `json:"template_id" toon:"template_id"`
	// Optional recurring time windows during which the rule applies.
	TimeFilters []CreateEscalationRuleRequestTimeFiltersItem `json:"time_filters,omitempty" toon:"time_filters,omitempty"`
}

CreateEscalationRuleRequest is generated from the Flashduty OpenAPI schema.

type CreateEscalationRuleRequestFiltersItemItem 

type CreateEscalationRuleRequestFiltersItemItem struct {
	// Field key (e.g. `alert_severity`, `labels.service`).
	Key string `json:"key" toon:"key"`
	// Filter operator.
	Oper string `json:"oper" toon:"oper"`
	// Values to match.
	Vals []string `json:"vals" toon:"vals"`
}

CreateEscalationRuleRequestFiltersItemItem is generated from the Flashduty OpenAPI schema.

type CreateEscalationRuleRequestLayersItem 

type CreateEscalationRuleRequestLayersItem struct {
	// Wait before moving to the next level, in minutes.
	EscalateWindow int64 `json:"escalate_window,omitempty" toon:"escalate_window,omitempty"`
	// When true, always escalate regardless of acknowledgement.
	ForceEscalate bool `json:"force_escalate,omitempty" toon:"force_escalate,omitempty"`
	// Max repeat notifications within the level.
	MaxTimes int64 `json:"max_times,omitempty" toon:"max_times,omitempty"`
	// Repeat interval in minutes.
	NotifyStep float64 `json:"notify_step,omitempty" toon:"notify_step,omitempty"`
	// Notification target. At least one of `person_ids`, `team_ids`, `schedule_to_role_ids`, or `emails` must be set, together with either `by` or `webhooks`.
	Target CreateEscalationRuleRequestLayersItemTarget `json:"target" toon:"target"`
}

CreateEscalationRuleRequestLayersItem is generated from the Flashduty OpenAPI schema.

type CreateEscalationRuleRequestLayersItemTarget 

type CreateEscalationRuleRequestLayersItemTarget struct {
	// Per-severity personal notification channels. Required unless `webhooks` is provided.
	By CreateEscalationRuleRequestLayersItemTargetBy `json:"by,omitzero" toon:"by,omitempty"`
	// Email addresses to notify (push-only scenarios).
	Emails []string `json:"emails,omitempty" toon:"emails,omitempty"`
	// Member IDs to notify directly; obtain member IDs from `POST /member/list`.
	PersonIDs []int64 `json:"person_ids,omitempty" toon:"person_ids,omitempty"`
	// Map of schedule ID to the role IDs on that schedule to notify.
	ScheduleToRoleIDs map[string][]int64 `json:"schedule_to_role_ids,omitempty" toon:"schedule_to_role_ids,omitempty"`
	// Team IDs to notify; obtain team IDs from `POST /team/list`.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
	// Group chat / webhook targets. Required unless `by` is provided.
	Webhooks []CreateEscalationRuleRequestLayersItemTargetWebhooksItem `json:"webhooks,omitempty" toon:"webhooks,omitempty"`
}

CreateEscalationRuleRequestLayersItemTarget is generated from the Flashduty OpenAPI schema.

type CreateEscalationRuleRequestLayersItemTargetBy 

type CreateEscalationRuleRequestLayersItemTargetBy struct {
	// Notify channels used for Critical severity. Personal channels: `sms`, `voice`, `email`, `push`; IM group-chat channels: `feishu_app:<chat_id>`, `dingtalk_app:<chat_id>`, `wecom_app:<chat_id>`, `slack_app:<chat_id>`, `teams_app:<chat_id>`.
	Critical []string `json:"critical,omitempty" toon:"critical,omitempty"`
	// When true, use each responder's personal preference instead of the lists below.
	FollowPreference bool `json:"follow_preference,omitempty" toon:"follow_preference,omitempty"`
	// Notify channels used for Info severity. Values as for `critical`.
	Info []string `json:"info,omitempty" toon:"info,omitempty"`
	// Notify channels used for Warning severity. Values as for `critical`.
	Warning []string `json:"warning,omitempty" toon:"warning,omitempty"`
}

CreateEscalationRuleRequestLayersItemTargetBy is generated from the Flashduty OpenAPI schema.

type CreateEscalationRuleRequestLayersItemTargetWebhooksItem 

type CreateEscalationRuleRequestLayersItemTargetWebhooksItem struct {
	// Type-specific settings (chat IDs, URLs, etc.).
	Settings map[string]any `json:"settings" toon:"settings"`
	// Webhook type, one of `feishu`, `feishu_app`, `dingtalk`, `dingtalk_app`, `wecom`, `slack`, `slack_app`, `teams_app`, `telegram`, `zoom`.
	Type string `json:"type" toon:"type"`
}

CreateEscalationRuleRequestLayersItemTargetWebhooksItem is generated from the Flashduty OpenAPI schema.

type CreateEscalationRuleRequestTimeFiltersItem 

type CreateEscalationRuleRequestTimeFiltersItem struct {
	// Optional calendar ID; restricts the window to days matching the calendar.
	CalID string `json:"cal_id,omitempty" toon:"cal_id,omitempty"`
	// End of the window in `HH:MM`.
	End string `json:"end,omitempty" toon:"end,omitempty"`
	// When true, match days marked as days-off in the calendar.
	IsOff bool `json:"is_off,omitempty" toon:"is_off,omitempty"`
	// Days of the week this window repeats on. Empty means every day.
	Repeat []int64 `json:"repeat,omitempty" toon:"repeat,omitempty"`
	// Start of the window in `HH:MM`.
	Start string `json:"start,omitempty" toon:"start,omitempty"`
}

CreateEscalationRuleRequestTimeFiltersItem is generated from the Flashduty OpenAPI schema.

type CreateFieldRequest 

type CreateFieldRequest struct {
	// Optional default value. Type must match `field_type`: `bool` for checkbox; one of `options` for single_select; subset of `options` for multi_select; string ≤3000 chars for text.
	DefaultValue any `json:"default_value,omitempty" toon:"default_value,omitempty"`
	// Optional free-text description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Human-readable name. Must be unique within the account.
	DisplayName string `json:"display_name" toon:"display_name"`
	// Machine name. Must start with a letter or underscore; 1–40 chars of `[a-zA-Z0-9_]`. Immutable after creation.
	FieldName string `json:"field_name" toon:"field_name"`
	// Field type, immutable after creation.
	// | Value | Meaning |
	// |---|---|
	// | `text` | Free text; `value_type` must be `string`, no `options`. |
	// | `single_select` | Single choice from `options`; `value_type` must be `string`. |
	// | `multi_select` | Multiple choices from `options`; `value_type` must be `string`. |
	// | `checkbox` | Boolean checkbox; `value_type` must be `bool`, no `options`. |
	FieldType string `json:"field_type" toon:"field_type"`
	// Required and non-empty for `single_select`/`multi_select` (unique strings, each 1–200 chars). Must be omitted or empty for `checkbox`/`text`.
	Options []string `json:"options,omitempty" toon:"options,omitempty"`
	// Value type. `checkbox` requires `bool`; all other types require `string`. Immutable after creation. `float` is a reserved value currently rejected for every `field_type`.
	ValueType string `json:"value_type" toon:"value_type"`
}

CreateFieldRequest is generated from the Flashduty OpenAPI schema.

type CreateFieldResponse 

type CreateFieldResponse struct {
	// Newly assigned field ID — 24-character hex ObjectID.
	FieldID string `json:"field_id" toon:"field_id"`
	// Echo of the submitted `field_name`.
	FieldName string `json:"field_name" toon:"field_name"`
}

CreateFieldResponse is generated from the Flashduty OpenAPI schema.

type CreateIncidentCommentTypeRequest added in v0.8.0 

type CreateIncidentCommentTypeRequest struct {
	// Label color as a hex value in #RRGGBB format. Normalized to uppercase.
	Color string `json:"color" toon:"color"`
	// Display name. Trimmed before storing; must be unique within the account (case-insensitive). At most 40 characters.
	Name string `json:"name" toon:"name"`
}

CreateIncidentCommentTypeRequest is generated from the Flashduty OpenAPI schema.

type CreateIncidentCommentTypeResponse added in v0.8.0 

type CreateIncidentCommentTypeResponse struct {
	// ID of the created comment type (24-character hex ObjectID).
	CommentTypeID string                  `json:"comment_type_id" toon:"comment_type_id"`
	Item          IncidentCommentTypeItem `json:"item" toon:"item"`
}

CreateIncidentCommentTypeResponse is generated from the Flashduty OpenAPI schema.

type CreateIncidentRequest 

type CreateIncidentRequest struct {
	// Incident assignment target. May be omitted entirely: when unset or empty, the channel's default assignment applies; required when the account's create form is in effect. `person_ids`, `escalate_rule_id`, and `emails` can be combined — responders are the union.
	AssignedTo CreateIncidentRequestAssignedTo `json:"assigned_to,omitzero" toon:"assigned_to,omitempty"`
	// Channel to file the incident into. Optional; leave unset for a standalone incident.
	ChannelID int64 `json:"channel_id,omitempty" toon:"channel_id,omitempty"`
	// Incident description, up to 1024 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Custom field values keyed by field name. When a create form applies, only its visible fields are accepted.
	Fields CustomFieldValues `json:"fields,omitempty" toon:"fields,omitempty"`
	// Incident severity: `Info`, `Warning` or `Critical` (most severe).
	IncidentSeverity string `json:"incident_severity" toon:"incident_severity"`
	// Incident title, up to 512 characters.
	Title string `json:"title,omitempty" toon:"title,omitempty"`
}

CreateIncidentRequest is generated from the Flashduty OpenAPI schema.

type CreateIncidentRequestAssignedTo 

type CreateIncidentRequestAssignedTo struct {
	// Recipients to assign by email (1–100): resolved to account members and merged into `person_ids`; emails with no matching member are ignored.
	Emails []string `json:"emails,omitempty" toon:"emails,omitempty"`
	// Escalation rule ID (MongoDB ObjectID); assigns the people at the rule's `layer_idx` layer.
	EscalateRuleID string `json:"escalate_rule_id,omitempty" toon:"escalate_rule_id,omitempty"`
	// Zero-based starting layer index of the escalation rule (default 0, the first layer); an out-of-range value returns an error. Only takes effect with `escalate_rule_id`.
	LayerIdx int64 `json:"layer_idx,omitempty" toon:"layer_idx,omitempty"`
	// Override the notification channels used for this assignment.
	Notify CreateIncidentRequestAssignedToNotify `json:"notify,omitzero" toon:"notify,omitempty"`
	// Member IDs to assign directly (1–100). Can be combined with `escalate_rule_id`.
	PersonIDs []int64 `json:"person_ids,omitempty" toon:"person_ids,omitempty"`
	// Assignment type, derived server-side — callers do not set it: `assign` for manual creation, `reassign` for re-assignment, `escalate` for escalation-driven assignment.
	// | Value | Meaning |
	// |---|---|
	// | `assign` | Initial assignment when the incident is created manually. |
	// | `reassign` | Re-assignment of an existing incident. |
	// | `escalate` | Assignment triggered by escalation policy advancement. |
	// | `reopen` | Assignment restarted from the first layer after the incident is reopened. |
	Type string `json:"type,omitempty" toon:"type,omitempty"`
}

CreateIncidentRequestAssignedTo is generated from the Flashduty OpenAPI schema.

type CreateIncidentRequestAssignedToNotify 

type CreateIncidentRequestAssignedToNotify struct {
	// When false, use `personal_channels`; when true or omitted, use each responder's personal preference.
	FollowPreference *bool `json:"follow_preference,omitempty" toon:"follow_preference,omitempty"`
	// Channels to use (e.g. `voice`, `sms`, `email`).
	PersonalChannels []string `json:"personal_channels,omitempty" toon:"personal_channels,omitempty"`
	// Notification template ID (MongoDB ObjectID).
	TemplateID string `json:"template_id,omitempty" toon:"template_id,omitempty"`
}

CreateIncidentRequestAssignedToNotify is generated from the Flashduty OpenAPI schema.

type CreateIncidentResponse 

type CreateIncidentResponse struct {
	// Newly created incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Echoes the incident title from the request.
	Title string `json:"title" toon:"title"`
}

CreateIncidentResponse is generated from the Flashduty OpenAPI schema.

type CreateInhibitRuleRequest 

type CreateInhibitRuleRequest struct {
	// Owning channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Rule description, up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Field keys whose values must be equal between the source (inhibiting) alert and the target (suppressed) alert, e.g. `data_source_id` or `labels.cluster`.
	Equals []string `json:"equals" toon:"equals"`
	// When true, matching alert events are discarded entirely; when false, alerts are still recorded but marked as muted by this rule.
	IsDirectlyDiscard bool `json:"is_directly_discard,omitempty" toon:"is_directly_discard,omitempty"`
	// Rule name, 1 to 39 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Conditions the source alert must match, evaluated against stored active alerts. Supported keys: `status`, `incident_status`, `alert_status`, `severity`, `incident_severity`, `alert_severity`, `title`, `description`, or any `labels.<name>`. Empty makes the rule inert.
	SourceFilters [][]CreateInhibitRuleRequestSourceFiltersItemItem `json:"source_filters,omitempty" toon:"source_filters,omitempty"`
	// Conditions the incoming target alert event must match to be suppressed; empty means every event is a target.
	TargetFilters [][]CreateInhibitRuleRequestTargetFiltersItemItem `json:"target_filters,omitempty" toon:"target_filters,omitempty"`
}

CreateInhibitRuleRequest is generated from the Flashduty OpenAPI schema.

type CreateInhibitRuleRequestSourceFiltersItemItem 

type CreateInhibitRuleRequestSourceFiltersItemItem struct {
	// Field key (e.g. `alert_severity`, `labels.service`).
	Key string `json:"key" toon:"key"`
	// Filter operator.
	Oper string `json:"oper" toon:"oper"`
	// Values to match.
	Vals []string `json:"vals" toon:"vals"`
}

CreateInhibitRuleRequestSourceFiltersItemItem is generated from the Flashduty OpenAPI schema.

type CreateInhibitRuleRequestTargetFiltersItemItem 

type CreateInhibitRuleRequestTargetFiltersItemItem struct {
	// Field key (e.g. `alert_severity`, `labels.service`).
	Key string `json:"key" toon:"key"`
	// Filter operator.
	Oper string `json:"oper" toon:"oper"`
	// Values to match.
	Vals []string `json:"vals" toon:"vals"`
}

CreateInhibitRuleRequestTargetFiltersItemItem is generated from the Flashduty OpenAPI schema.

type CreateSilenceRuleRequest 

type CreateSilenceRuleRequest struct {
	// Owning channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Rule description, up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Alert event match conditions (OR-of-AND). Required and must contain at least one condition.
	Filters [][]CreateSilenceRuleRequestFiltersItemItem `json:"filters,omitempty" toon:"filters,omitempty"`
	// Incident ID (ObjectID hex) to attach the rule to. Optional; when set, only one enabled silence rule may exist per incident.
	FromIncidentID string `json:"from_incident_id,omitempty" toon:"from_incident_id,omitempty"`
	// When true, the silence rule is automatically deleted after its time window expires. Defaults to false.
	IsAutoDelete bool `json:"is_auto_delete,omitempty" toon:"is_auto_delete,omitempty"`
	// When true, matching alert events are discarded entirely; when false, alerts are still recorded but marked as muted by this rule.
	IsDirectlyDiscard bool `json:"is_directly_discard,omitempty" toon:"is_directly_discard,omitempty"`
	// Rule name, 1 to 39 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// One-off time window defined by unix seconds.
	TimeFilter CreateSilenceRuleRequestTimeFilter `json:"time_filter,omitzero" toon:"time_filter,omitempty"`
	// Recurring time windows during which silencing applies. Mutually exclusive with `time_filter`.
	TimeFilters []CreateSilenceRuleRequestTimeFiltersItem `json:"time_filters,omitempty" toon:"time_filters,omitempty"`
}

CreateSilenceRuleRequest is generated from the Flashduty OpenAPI schema.

type CreateSilenceRuleRequestFiltersItemItem 

type CreateSilenceRuleRequestFiltersItemItem struct {
	// Field key (e.g. `alert_severity`, `labels.service`).
	Key string `json:"key" toon:"key"`
	// Filter operator.
	Oper string `json:"oper" toon:"oper"`
	// Values to match.
	Vals []string `json:"vals" toon:"vals"`
}

CreateSilenceRuleRequestFiltersItemItem is generated from the Flashduty OpenAPI schema.

type CreateSilenceRuleRequestTimeFilter 

type CreateSilenceRuleRequestTimeFilter struct {
	// Window end, Unix timestamp in seconds. Must be greater than 0.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// Window start, Unix timestamp in seconds. Must be greater than 0 and less than `end_time`.
	StartTime int64 `json:"start_time" toon:"start_time"`
}

CreateSilenceRuleRequestTimeFilter is generated from the Flashduty OpenAPI schema.

type CreateSilenceRuleRequestTimeFiltersItem 

type CreateSilenceRuleRequestTimeFiltersItem struct {
	// Optional calendar ID; restricts the window to days matching the calendar.
	CalID string `json:"cal_id,omitempty" toon:"cal_id,omitempty"`
	// End of the window in `HH:MM`.
	End string `json:"end,omitempty" toon:"end,omitempty"`
	// When true, match days marked as days-off in the calendar.
	IsOff bool `json:"is_off,omitempty" toon:"is_off,omitempty"`
	// Days of the week this window repeats on. Empty means every day.
	Repeat []int64 `json:"repeat,omitempty" toon:"repeat,omitempty"`
	// Start of the window in `HH:MM`.
	Start string `json:"start,omitempty" toon:"start,omitempty"`
}

CreateSilenceRuleRequestTimeFiltersItem is generated from the Flashduty OpenAPI schema.

type CreateStatusPageChangeRequest 

type CreateStatusPageChangeRequest struct {
	// Maintenance only: automatically advance the status based on the scheduled window.
	AutoUpdateBySchedule bool `json:"auto_update_by_schedule,omitempty" toon:"auto_update_by_schedule,omitempty"`
	// Event close time in Unix seconds. Must be greater than or equal to the first update's `at_seconds`. For retrospective events this is the time the event ended; for maintenances with `auto_update_by_schedule` it schedules the automatic transition to `completed` and must be within 30 days from now.
	CloseAtSeconds int64 `json:"close_at_seconds,omitempty" toon:"close_at_seconds,omitempty"`
	// Event description (Markdown). Must not be empty.
	Description string `json:"description" toon:"description"`
	// Mark this event as a retrospective (historical) one.
	IsRetrospective bool `json:"is_retrospective,omitempty" toon:"is_retrospective,omitempty"`
	// Linked change IDs (related incidents, deployments, etc.).
	LinkedChanges []string `json:"linked_changes,omitempty" toon:"linked_changes,omitempty"`
	// Notify subscribers about this event and all its updates.
	NotifySubscribers bool `json:"notify_subscribers,omitempty" toon:"notify_subscribers,omitempty"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Member IDs responsible for the event.
	Responders []int64 `json:"responders,omitempty" toon:"responders,omitempty"`
	// Event start time in Unix seconds. The stored start time is always derived from the first update's `at_seconds` (which defaults to the current time when omitted); for maintenances with `auto_update_by_schedule`, this value schedules the automatic transition to `ongoing`.
	StartAtSeconds int64 `json:"start_at_seconds,omitempty" toon:"start_at_seconds,omitempty"`
	// Initial event status. `investigating`/`identified`/`monitoring`/`resolved` apply to incidents; `scheduled`/`ongoing`/`completed` apply to maintenances.
	Status string `json:"status" toon:"status"`
	// Event title, up to 255 characters.
	Title string `json:"title" toon:"title"`
	// Change type: `incident` unplanned incident, `maintenance` planned maintenance.
	Type string `json:"type" toon:"type"`
	// Timeline updates. At least one update is required, and at least one of them must contain `component_changes`. Immediate events normally pass one update; retrospective events must pass all historical updates.
	Updates []CreateStatusPageChangeRequestUpdatesItem `json:"updates" toon:"updates"`
}

CreateStatusPageChangeRequest is generated from the Flashduty OpenAPI schema.

type CreateStatusPageChangeRequestUpdatesItem 

type CreateStatusPageChangeRequestUpdatesItem struct {
	// Update timestamp in Unix seconds. When omitted or 0 on the first update, defaults to the current time.
	AtSeconds int64 `json:"at_seconds,omitempty" toon:"at_seconds,omitempty"`
	// Component status transitions applied by this update.
	ComponentChanges []CreateStatusPageChangeRequestUpdatesItemComponentChangesItem `json:"component_changes,omitempty" toon:"component_changes,omitempty"`
	// Update description (Markdown).
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// Change status after this update. May be omitted (or null) when the overall status does not change. The first four values apply to incident-type changes, the last three to maintenance-type changes.
	// | Value | Meaning |
	// |---|---|
	// | `investigating` | Investigating (incident). |
	// | `identified` | Root cause identified (incident). |
	// | `monitoring` | Fix deployed, monitoring (incident). |
	// | `resolved` | Resolved (incident). |
	// | `scheduled` | Scheduled (maintenance). |
	// | `ongoing` | In progress (maintenance). |
	// | `completed` | Completed (maintenance). |
	Status *string `json:"status,omitempty" toon:"status,omitempty"`
	// Update ID. Server-assigned on create; supply when replaying historical updates.
	UpdateID string `json:"update_id,omitempty" toon:"update_id,omitempty"`
}

CreateStatusPageChangeRequestUpdatesItem is generated from the Flashduty OpenAPI schema.

type CreateStatusPageChangeRequestUpdatesItemComponentChangesItem 

type CreateStatusPageChangeRequestUpdatesItemComponentChangesItem struct {
	// Component ID; obtain it from `GET /status-page/info`.
	ComponentID string `json:"component_id" toon:"component_id"`
	// New component status. `operational`/`degraded`/`partial_outage`/`full_outage` apply to incidents; `operational`/`under_maintenance` apply to maintenances.
	Status string `json:"status" toon:"status"`
}

CreateStatusPageChangeRequestUpdatesItemComponentChangesItem is generated from the Flashduty OpenAPI schema.

type CreateStatusPageChangeTimelineRequest 

type CreateStatusPageChangeTimelineRequest struct {
	// Update timestamp in Unix seconds. Defaults to the current time when omitted or 0.
	AtSeconds int64 `json:"at_seconds,omitempty" toon:"at_seconds,omitempty"`
	// Target change ID; obtain it from `GET /status-page/change/list`.
	ChangeID int64 `json:"change_id" toon:"change_id"`
	// Component status transitions applied by this update. Component IDs must be unique.
	ComponentChanges []CreateStatusPageChangeTimelineRequestComponentChangesItem `json:"component_changes,omitempty" toon:"component_changes,omitempty"`
	// Update description (Markdown). Must not be empty.
	Description string `json:"description" toon:"description"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Change status after this update; must be valid for the change type. When transitioning to `resolved` or `completed`, all affected components must be back to `operational`.
	// | Value | Meaning |
	// |---|---|
	// | `investigating` | Investigating (incident). |
	// | `identified` | Root cause identified (incident). |
	// | `monitoring` | Fix deployed, monitoring (incident). |
	// | `resolved` | Resolved (incident). |
	// | `scheduled` | Scheduled (maintenance). |
	// | `ongoing` | In progress (maintenance). |
	// | `completed` | Completed (maintenance). |
	Status string `json:"status" toon:"status"`
}

CreateStatusPageChangeTimelineRequest is generated from the Flashduty OpenAPI schema.

type CreateStatusPageChangeTimelineRequestComponentChangesItem 

type CreateStatusPageChangeTimelineRequestComponentChangesItem struct {
	// Component ID; obtain it from `GET /status-page/info`.
	ComponentID string `json:"component_id" toon:"component_id"`
	// New component status. `operational`/`degraded`/`partial_outage`/`full_outage` apply to incidents; `operational`/`under_maintenance` apply to maintenances.
	Status string `json:"status" toon:"status"`
}

CreateStatusPageChangeTimelineRequestComponentChangesItem is generated from the Flashduty OpenAPI schema.

type CreateStatusPageDraftRequest added in v0.14.5 

type CreateStatusPageDraftRequest struct {
	// Draft payload, stored verbatim, up to 64 KB serialized. Validated fields: `page_id`, `type` (`incident` or `maintenance`), `name`, `message`; optional `change_id` (append an update to an existing event when > 0), `status`, `affected_components`, and `start_time`/`end_time` (Unix epoch seconds, new maintenance only).
	Draft map[string]any `json:"draft" toon:"draft"`
	// Opaque marker of the drafting origin, e.g. `ai_sre:sess_xxx`. Up to 64 characters.
	Source string `json:"source,omitempty" toon:"source,omitempty"`
}

CreateStatusPageDraftRequest is generated from the Flashduty OpenAPI schema.

type CreateStatusPageRequest added in v0.5.5 

type CreateStatusPageRequest struct {
	// Get-in-touch contact, such as a mailto or website URL.
	ContactInfo string `json:"contact_info,omitempty" toon:"contact_info,omitempty"`
	// Custom domain for a public status page.
	CustomDomain string `json:"custom_domain,omitempty" toon:"custom_domain,omitempty"`
	// Custom navigation links shown on the status page.
	CustomLinks []map[string]string `json:"custom_links,omitempty" toon:"custom_links,omitempty"`
	// How change dates are displayed: `calendar` calendar view, `list` list view.
	DateView string `json:"date_view" toon:"date_view"`
	// Uptime display mode: `chart_and_percentage` chart plus percentage, `chart` chart only, `none` hidden.
	DisplayUptimeMode string `json:"display_uptime_mode" toon:"display_uptime_mode"`
	// Display name of the status page.
	Name string `json:"name" toon:"name"`
	// Footer content shown on the status page.
	PageFooter string `json:"page_footer,omitempty" toon:"page_footer,omitempty"`
	// Header content shown on the status page.
	PageHeader string `json:"page_header,omitempty" toon:"page_header,omitempty"`
	// Browser title shown for the status page.
	PageTitle string `json:"page_title,omitempty" toon:"page_title,omitempty"`
	// Subscription channel toggles.
	Subscription StatusPageSubscriptionItem `json:"subscription,omitzero" toon:"subscription,omitempty"`
	// Visibility type: `public` accessible to anyone, `internal` restricted to logged-in members of this account.
	Type string `json:"type" toon:"type"`
	// URL-safe slug, unique per account and page type.
	URLName string `json:"url_name" toon:"url_name"`
}

CreateStatusPageRequest is generated from the Flashduty OpenAPI schema.

type CreateStatusPageResponse added in v0.5.5 

type CreateStatusPageResponse struct {
	// Created status page ID.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Created status page name.
	PageName string `json:"page_name" toon:"page_name"`
	// Final URL-safe slug assigned to the status page.
	PageURLName string `json:"page_url_name" toon:"page_url_name"`
}

CreateStatusPageResponse is generated from the Flashduty OpenAPI schema.

type CreateWarRoomRequest 

type CreateWarRoomRequest struct {
	// When true, also add historical responders of the incident as observers.
	AddObservers bool `json:"add_observers,omitempty" toon:"add_observers,omitempty"`
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// IM integration ID. Must have war room enabled; Feishu, DingTalk, WeCom (self-built), Slack and Teams are supported.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Additional member IDs to add to the war room.
	MemberIDs []int64 `json:"member_ids,omitempty" toon:"member_ids,omitempty"`
}

CreateWarRoomRequest is generated from the Flashduty OpenAPI schema.

type CreateWorkItemRequest added in v0.8.0 

type CreateWorkItemRequest struct {
	// Initial assignee member IDs. Assignees must be active members who can already read the anchor; assignment never grants access.
	AssigneeIDs []int64 `json:"assignee_ids,omitempty" toon:"assignee_ids,omitempty"`
	// Optional longer description (max 65,535 characters).
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Client-generated idempotency key (max 128 characters; letters, digits, `_`, `-`, `.`, `:` only).
	IdempotencyKey string `json:"idempotency_key" toon:"idempotency_key"`
	// Incident ID (MongoDB ObjectID) the item is anchored to.
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// `action` anchors to an active incident and must not set `post_mortem_id`; `follow_up` requires `post_mortem_id`.
	ItemType string `json:"item_type" toon:"item_type"`
	// Post-mortem ID (32-character hex string). Required for `follow_up`, forbidden for `action`. The post-mortem must be linked to `incident_id`.
	PostMortemID string `json:"post_mortem_id,omitempty" toon:"post_mortem_id,omitempty"`
	// Optional client-defined priority (max 64 characters).
	Priority string `json:"priority,omitempty" toon:"priority,omitempty"`
	// Optional client-defined initial status (max 64 characters).
	Status string `json:"status,omitempty" toon:"status,omitempty"`
	// Item title (max 512 characters).
	Title string `json:"title" toon:"title"`
}

CreateWorkItemRequest is generated from the Flashduty OpenAPI schema.

type CustomFieldValues added in v0.5.7 

type CustomFieldValues struct{}

CustomFieldValues is generated from the Flashduty OpenAPI schema.

type DataQueryService added in v0.5.4 

type DataQueryService service

DataQueryService handles the "RUM/Data query" API resource.

func (*DataQueryService) Query added in v0.5.4 

func (s *DataQueryService) Query(ctx context.Context, req *RUMDataQueryRequest) (*RUMDataQueryResponse, *Response, error)

Query RUM data.

Run one or more SQL-style RUM data queries over a bounded time range.

API: POST /rum/data/query (rum-read-data-query).

type DataSourceItem 

type DataSourceItem struct {
	// Account ID.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Connection address. For Prometheus/Loki/VictoriaLogs: HTTP URL. For MySQL/Oracle/Postgres/ClickHouse: `host:port`. For SLS: endpoint without http/https prefix. Redis/MongoDB diagnostic types: one host:port, bracket IPv6; no URI, userinfo or query. Kafka: 1–32 unique comma-separated host:port bootstrap addresses; payload has no broker list. At most 4096 characters after normalization.
	Address string `json:"address" toon:"address"`
	// Whether alert evaluation is allowed. Alerting also requires enabled=true and an alerting-capable type. Always false for diagnostic-only types; false does not block non-alerting queries or tools.
	AlertingEnabled bool `json:"alerting_enabled" toon:"alerting_enabled"`
	// Monitors edge cluster name responsible for evaluating rules using this datasource.
	EdgeClusterName string `json:"edge_cluster_name" toon:"edge_cluster_name"`
	// Whether business execution is enabled. Disabled datasources reject business queries and tools; enabling does not change alerting_enabled.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Unique datasource ID.
	ID uint64 `json:"id" toon:"id"`
	// Datasource display name.
	Name string `json:"name" toon:"name"`
	// Optional description.
	Note string `json:"note" toon:"note"`
	// Type-specific configuration block; must contain the key matching `type_ident`. Always `null` in `/monit/datasource/list` responses (the list query does not read the payload column); populated in create/update/info responses. For `tencent_cls`, `secret_key` is masked to an empty string unless it is an `${env:...}` reference. For diagnostic types, password and Kafka tls_key are omitted from responses unless they are ${env:...} references. On update, omit those fields to preserve stored secrets; explicitly send an empty string to clear. Other configuration fields retain their existing behavior.
	Payload any `json:"payload" toon:"payload"`
	// Datasource type identifier. Allowed: `prometheus`, `loki`, `mysql`, `oracle`, `postgres`, `clickhouse`, `elasticsearch`, `sls`, `tencent_cls`, `victorialogs`, `redis_node`, `redis_sentinel`, `mongodb_mongod`, `mongodb_mongos`, `kafka`。
	TypeIdent string `json:"type_ident" toon:"type_ident"`
	// Last update timestamp, Unix epoch seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

DataSourceItem is generated from the Flashduty OpenAPI schema.

type DataSourceListRequest 

type DataSourceListRequest struct {
	// Datasource type identifier. Omit to return all types. Allowed: `prometheus`, `loki`, `mysql`, `oracle`, `postgres`, `clickhouse`, `elasticsearch`, `sls`, `tencent_cls`, `victorialogs`, `redis_node`, `redis_sentinel`, `mongodb_mongod`, `mongodb_mongos`, `kafka`。
	Type string `json:"type,omitempty" toon:"type,omitempty"`
}

DataSourceListRequest is generated from the Flashduty OpenAPI schema.

type DataSourceListResponse 

type DataSourceListResponse []DataSourceItem

DataSourceListResponse is a list response payload.

type DataSourceUpsertRequest 

type DataSourceUpsertRequest struct {
	// Connection address. Required for every type except `elasticsearch` with `deployment: cloud`. Prometheus/Loki/VictoriaLogs: HTTP URL; MySQL/Oracle/Postgres/ClickHouse: `host:port`; SLS: endpoint without the `http(s)://` prefix; `tencent_cls`: must be `cls.tencentcloudapi.com` or `cls.internal.tencentcloudapi.com` (requires Monitors edge >= v0.66.0). Redis/MongoDB diagnostic types: one host:port, bracket IPv6; no URI, userinfo or query. Kafka: 1–32 unique comma-separated host:port bootstrap addresses; payload has no broker list. At most 4096 characters after normalization.
	Address string `json:"address,omitempty" toon:"address,omitempty"`
	// Whether this datasource may evaluate alerts. Omitted on create: true for alerting types, false for diagnostic-only types; omitted on update: preserve current value. null is invalid. redis_node, redis_sentinel, mongodb_mongod, mongodb_mongos and kafka reject true. Disabling is rejected with conflict when enabled rules reference the datasource.
	AlertingEnabled *bool `json:"alerting_enabled,omitempty" toon:"alerting_enabled,omitempty"`
	// Monitors edge cluster name responsible for evaluating rules using this datasource.
	EdgeClusterName string `json:"edge_cluster_name" toon:"edge_cluster_name"`
	// Whether business execution is enabled. Omitted on create: true; omitted on update: preserve the current value. Explicit false disables execution; null is invalid. Does not change alerting_enabled.
	Enabled *bool `json:"enabled,omitempty" toon:"enabled,omitempty"`
	// Datasource ID. Required for update; omit for create.
	ID uint64 `json:"id,omitempty" toon:"id,omitempty"`
	// Datasource display name. This is the name referenced as `ds_name` in query and diagnose APIs.
	Name string `json:"name" toon:"name"`
	// Optional description.
	Note string `json:"note,omitempty" toon:"note,omitempty"`
	// Type-specific configuration block. Must include the key matching `type_ident`. For diagnostic types, password and Kafka tls_key are omitted from responses unless they are ${env:...} references. On update, omit those fields to preserve stored secrets; explicitly send an empty string to clear. Other configuration fields retain their existing behavior.
	Payload DsPayload `json:"payload" toon:"payload"`
	// Datasource type identifier. Allowed: `prometheus`, `loki`, `mysql`, `oracle`, `postgres`, `clickhouse`, `elasticsearch`, `sls`, `tencent_cls`, `victorialogs`, `redis_node`, `redis_sentinel`, `mongodb_mongod`, `mongodb_mongos`, `kafka`。
	TypeIdent string `json:"type_ident" toon:"type_ident"`
}

DataSourceUpsertRequest is generated from the Flashduty OpenAPI schema.

type DataSourcesService 

type DataSourcesService service

DataSourcesService handles the "Monitors/Data sources" API resource.

func (*DataSourcesService) ReadInfo 

func (s *DataSourcesService) ReadInfo(ctx context.Context, req *IDRequest) (*DataSourceItem, *Response, error)

Get datasource detail.

Retrieve full details of a single data source by its ID, including the `payload` configuration with its configured connection and authentication settings; treat the response as sensitive and avoid logging or forwarding it. Supports diagnostic types redis_node, redis_sentinel, mongodb_mongod, mongodb_mongos and kafka; enabled and alerting_enabled are independent.

API: POST /monit/datasource/info (monit-datasource-read-info).

func (*DataSourcesService) ReadList 

func (s *DataSourcesService) ReadList(ctx context.Context, req *DataSourceListRequest) (*DataSourceListResponse, *Response, error)

List datasources.

Return all data sources for the current account. Optionally filter by `type_ident`. Supports diagnostic types redis_node, redis_sentinel, mongodb_mongod, mongodb_mongos and kafka; enabled and alerting_enabled are independent.

API: POST /monit/datasource/list (monit-datasource-read-list).

func (*DataSourcesService) ReadSLSLogstores 

func (s *DataSourcesService) ReadSLSLogstores(ctx context.Context, req *SLSLogstoresRequest) (*SLSLogstoresResponse, *Response, error)

List SLS logstores.

List logstores within an SLS project for the specified SLS datasource.

API: POST /monit/datasource/sls/logstores (monit-datasource-read-sls-logstores).

func (*DataSourcesService) ReadSLSProjects 

func (s *DataSourcesService) ReadSLSProjects(ctx context.Context, req *SLSProjectsRequest) (*SLSProjectsResponse, *Response, error)

List SLS projects.

List Alibaba Cloud SLS (Simple Log Service) projects available in the specified SLS datasource.

API: POST /monit/datasource/sls/projects (monit-datasource-read-sls-projects).

func (*DataSourcesService) ToolsInvoke added in v0.15.0 

func (s *DataSourcesService) ToolsInvoke(ctx context.Context, req *DatasourceToolInvokeRequest) (*DatasourceToolResult, *Response, error)

Invoke datasource tool.

Execute one deterministic tool against a configured datasource. Requires all currently online routable Edge sessions in the cluster to support the v0.71.0 base invoke protocol; individual tools may require a newer implementation. No tool catalog, automatic replay, or fallback to Agent/legacy diagnose. Request body limit 128 KiB; complete success response limit 1 MiB; tool timeout at most 25 seconds.

API: POST /monit/datasource/tools/invoke (monit-datasource-tools-invoke).

func (*DataSourcesService) WriteCreate 

func (s *DataSourcesService) WriteCreate(ctx context.Context, req *DataSourceUpsertRequest) (*DataSourceItem, *Response, error)

Create datasource.

Create a new monitoring data source. The `payload` must include the type-specific configuration block. Supports diagnostic types redis_node, redis_sentinel, mongodb_mongod, mongodb_mongos and kafka; enabled and alerting_enabled are independent.

API: POST /monit/datasource/create (monit-datasource-write-create).

func (*DataSourcesService) WriteDelete 

func (s *DataSourcesService) WriteDelete(ctx context.Context, req *IDRequest) (*Response, error)

Delete datasource.

Delete a data source by ID. Alert rules referencing this datasource are not blocked: the datasource is removed from their monitoring scope and their open alerts on it are closed automatically.

API: POST /monit/datasource/delete (monit-datasource-write-delete).

func (*DataSourcesService) WriteUpdate 

func (s *DataSourcesService) WriteUpdate(ctx context.Context, req *DataSourceUpsertRequest) (*DataSourceItem, *Response, error)

Update datasource.

Update an existing data source. Supply `id` plus the fields to change. Supports diagnostic types redis_node, redis_sentinel, mongodb_mongod, mongodb_mongos and kafka; enabled and alerting_enabled are independent.

API: POST /monit/datasource/update (monit-datasource-write-update).

type DatasourceToolInvokeRequest added in v0.15.0 

type DatasourceToolInvokeRequest struct {
	// Optional consistency check; must equal the authenticated account.
	AccountID uint64 `json:"account_id,omitempty" toon:"account_id,omitempty"`
	// Datasource ID from /monit/datasource/list.
	DatasourceID uint64 `json:"datasource_id" toon:"datasource_id"`
	// Tool-specific JSON parameters; omitted means {}. Explicit null is invalid.
	Params json.RawMessage `json:"params,omitempty" toon:"params,omitempty"`
	// Single tool name prefixed by the datasource type, e.g. mysql.overview. Free SQL uses /monit/query/data; mysql.query and postgres.query are unsupported.
	Tool string `json:"tool" toon:"tool"`
}

DatasourceToolInvokeRequest is generated from the Flashduty OpenAPI schema.

type DatasourceToolResult added in v0.15.0 

type DatasourceToolResult struct {
	// Tool-specific JSON evidence, preserved without conversion; never null. No nested legacy diagnose envelope.
	Data json.RawMessage `json:"data" toon:"data"`
	// Datasource ID from /monit/datasource/list.
	DatasourceID uint64 `json:"datasource_id" toon:"datasource_id"`
	// Optional non-empty summary.
	Summary *string `json:"summary,omitempty" toon:"summary,omitempty"`
	// Executed tool name matching the request.
	Tool      string                    `json:"tool" toon:"tool"`
	Truncated *DatasourceToolTruncation `json:"truncated,omitempty" toon:"truncated,omitempty"`
}

DatasourceToolResult is generated from the Flashduty OpenAPI schema.

type DatasourceToolTruncation added in v0.15.0 

type DatasourceToolTruncation struct {
	// Why the result was truncated. Presence of this object indicates truncation.
	Reason string `json:"reason" toon:"reason"`
}

DatasourceToolTruncation is generated from the Flashduty OpenAPI schema.

type DeleteFieldRequest 

type DeleteFieldRequest struct {
	// Field ID — 24-character hex ObjectID.
	FieldID string `json:"field_id" toon:"field_id"`
}

DeleteFieldRequest is generated from the Flashduty OpenAPI schema.

type DeleteIncidentCommentTypeRequest added in v0.8.0 

type DeleteIncidentCommentTypeRequest struct {
	// ID of the comment type to delete (24-character hex ObjectID).
	CommentTypeID string `json:"comment_type_id" toon:"comment_type_id"`
}

DeleteIncidentCommentTypeRequest is generated from the Flashduty OpenAPI schema.

type DeletePostMortemRequest 

type DeletePostMortemRequest struct {
	// Post-mortem report ID; obtain it from `POST /incident/post-mortem/list`.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
}

DeletePostMortemRequest is generated from the Flashduty OpenAPI schema.

type DeletePostMortemTemplateRequest added in v0.5.4 

type DeletePostMortemTemplateRequest struct {
	// Template ID; obtain it from `POST /incident/post-mortem/template/list`.
	TemplateID string `json:"template_id" toon:"template_id"`
}

DeletePostMortemTemplateRequest is generated from the Flashduty OpenAPI schema.

type DeleteStatusPageChangeRequest 

type DeleteStatusPageChangeRequest struct {
	// Target change ID; obtain it from `GET /status-page/change/list`.
	ChangeID int64 `json:"change_id" toon:"change_id"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
}

DeleteStatusPageChangeRequest is generated from the Flashduty OpenAPI schema.

type DeleteStatusPageChangeTimelineRequest 

type DeleteStatusPageChangeTimelineRequest struct {
	// Owning change ID; obtain it from `GET /status-page/change/list`.
	ChangeID int64 `json:"change_id" toon:"change_id"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Timeline update ID to delete; obtain it from `GET /status-page/change/info`.
	UpdateID string `json:"update_id" toon:"update_id"`
}

DeleteStatusPageChangeTimelineRequest is generated from the Flashduty OpenAPI schema.

type DeleteStatusPageComponentRequest added in v0.5.4 

type DeleteStatusPageComponentRequest struct {
	// Component IDs to delete; obtain them from `GET /status-page/info`.
	ComponentIDs []string `json:"component_ids" toon:"component_ids"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
}

DeleteStatusPageComponentRequest is generated from the Flashduty OpenAPI schema.

type DeleteStatusPageRequest added in v0.6.0 

type DeleteStatusPageRequest struct {
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
}

DeleteStatusPageRequest is generated from the Flashduty OpenAPI schema.

type DeleteStatusPageSectionRequest added in v0.5.4 

type DeleteStatusPageSectionRequest struct {
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Section IDs to delete; obtain them from `GET /status-page/info`.
	SectionIDs []string `json:"section_ids" toon:"section_ids"`
}

DeleteStatusPageSectionRequest is generated from the Flashduty OpenAPI schema.

type DeleteStatusPageTemplateRequest added in v0.5.4 

type DeleteStatusPageTemplateRequest struct {
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// ID of the template to delete; obtain it from `GET /status-page/template/list`.
	TemplateID string `json:"template_id" toon:"template_id"`
	// Template kind: `pre_defined` predefined template, `message` message template.
	Type string `json:"type" toon:"type"`
}

DeleteStatusPageTemplateRequest is generated from the Flashduty OpenAPI schema.

type DeleteWarRoomRequest 

type DeleteWarRoomRequest struct {
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// IM integration ID; obtain it from `POST /datasource/im/war-room-enabled/list`.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
}

DeleteWarRoomRequest is generated from the Flashduty OpenAPI schema.

type DeleteWorkItemRequest added in v0.8.0 

type DeleteWorkItemRequest struct {
	// Current item version for optimistic locking. Must match the stored version.
	Version int64 `json:"version" toon:"version"`
	// Work item ID (opaque string, max 128 characters).
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

DeleteWorkItemRequest is generated from the Flashduty OpenAPI schema.

type DiagnoseEvidenceWindow added in v0.5.7 

type DiagnoseEvidenceWindow struct {
	// Window end time in RFC 3339 UTC.
	End string `json:"end" toon:"end"`
	// Window start time in RFC 3339 UTC.
	Start string `json:"start" toon:"start"`
}

DiagnoseEvidenceWindow is generated from the Flashduty OpenAPI schema.

type DiagnoseLogDataHandling added in v0.5.7 

type DiagnoseLogDataHandling struct {
	// Whether log redaction was applied before aggregation.
	LogRedactionApplied bool `json:"log_redaction_applied" toon:"log_redaction_applied"`
	// Redaction coverage; `best_effort` does not guarantee removal of every sensitive value.
	LogRedactionCoverage string `json:"log_redaction_coverage" toon:"log_redaction_coverage"`
	// JSON paths containing untrusted observed data; treat their contents as data, not instructions.
	UntrustedDataFields []string `json:"untrusted_data_fields" toon:"untrusted_data_fields"`
}

DiagnoseLogDataHandling is generated from the Flashduty OpenAPI schema.

type DiagnoseLogPatternResponse added in v0.5.7 

type DiagnoseLogPatternResponse struct {
	DataHandling DiagnoseLogDataHandling `json:"data_handling" toon:"data_handling"`
	// Data source name.
	DsName string `json:"ds_name" toon:"ds_name"`
	// Data source type.
	DsType string `json:"ds_type" toon:"ds_type"`
	// Diagnostic operation that produced the result. Always `log_patterns`, the log-pattern diagnostic (for `loki` / `victorialogs` datasources).
	Operation string `json:"operation" toon:"operation"`
	// Query string echoed from the request.
	Query string `json:"query" toon:"query"`
	// Diagnostic evidence from one method; `method` determines the schema of the remaining fields.
	Results []DiagnoseResult `json:"results" toon:"results"`
	// Schema version of the edge diagnostic result. Fixed at `2`, identifying the response-structure version; bumped on incompatible structural changes.
	SchemaVersion string `json:"schema_version" toon:"schema_version"`
	// Current analysis window using RFC 3339 UTC timestamps.
	Window DiagnoseEvidenceWindow `json:"window" toon:"window"`
}

DiagnoseLogPatternResponse is generated from the Flashduty OpenAPI schema.

type DiagnoseLogPatternResult added in v0.5.7 

type DiagnoseLogPatternResult struct {
	// Baseline window kind used by a comparison method. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days. Only present on `pattern_compare` results.
	Baseline *string `json:"baseline,omitempty" toon:"baseline,omitempty"`
	// Baseline time window used by a comparison method.
	BaselineWindow *DiagnoseEvidenceWindow `json:"baseline_window,omitempty" toon:"baseline_window,omitempty"`
	// Diagnostic method that produced this evidence. `pattern_snapshot` = pattern aggregation snapshot of the current window only, no baseline involved; `pattern_compare` = pattern comparison between the current window and the baseline window (see `baseline`).
	Method string `json:"method" toon:"method"`
	// Log-pattern evidence ordered for RCA use.
	PatternEvidence []LogPatternEvidence  `json:"pattern_evidence" toon:"pattern_evidence"`
	Summary         DiagnoseMethodSummary `json:"summary" toon:"summary"`
	// Non-fatal warnings produced during analysis.
	Warnings []string `json:"warnings" toon:"warnings"`
	// Current analysis window using RFC 3339 UTC timestamps.
	Window DiagnoseEvidenceWindow `json:"window" toon:"window"`
}

DiagnoseLogPatternResult is generated from the Flashduty OpenAPI schema.

type DiagnoseMethodSummary added in v0.5.7 

type DiagnoseMethodSummary struct {
	// Total aggregated pattern evidence items before the response limit is applied.
	AggregatedPatternEvidenceTotal *int64 `json:"aggregated_pattern_evidence_total,omitempty" toon:"aggregated_pattern_evidence_total,omitempty"`
	// Whether `max_series` prevented full analysis of all input series.
	AnalysisTruncated *bool `json:"analysis_truncated,omitempty" toon:"analysis_truncated,omitempty"`
	// Log sample summary for the baseline window.
	BaselineSample *LogPatternSampleSummary `json:"baseline_sample,omitempty" toon:"baseline_sample,omitempty"`
	// Log sample summary for the current window.
	CurrentSample *LogPatternSampleSummary `json:"current_sample,omitempty" toon:"current_sample,omitempty"`
	// Factual summary generated from coverage, selection, and return counts.
	EvidenceSummary string `json:"evidence_summary" toon:"evidence_summary"`
	// Number of pattern evidence items returned in this response.
	PatternEvidenceReturned *int64 `json:"pattern_evidence_returned,omitempty" toon:"pattern_evidence_returned,omitempty"`
	// Whether returned pattern evidence was truncated by `max_patterns`.
	PatternEvidenceTruncatedByMaxPatterns *bool `json:"pattern_evidence_truncated_by_max_patterns,omitempty" toon:"pattern_evidence_truncated_by_max_patterns,omitempty"`
	// Number of aggregated patterns observed only in the baseline sample. Omitted when sampling is incomplete.
	PatternsAggregatedOnlyInBaselineSample *int64 `json:"patterns_aggregated_only_in_baseline_sample,omitempty" toon:"patterns_aggregated_only_in_baseline_sample,omitempty"`
	// Series matching internal selection rules before `topk` is applied.
	SelectedSeriesTotal *int64 `json:"selected_series_total,omitempty" toon:"selected_series_total,omitempty"`
	// Number of series analyzed after applying `max_series`.
	SeriesAnalyzed *int64 `json:"series_analyzed,omitempty" toon:"series_analyzed,omitempty"`
	// Number of `series_evidence` items returned in this response.
	SeriesReturned *int64 `json:"series_returned,omitempty" toon:"series_returned,omitempty"`
	// Total input series; for comparisons, the union of current and baseline label sets.
	SeriesTotal *int64 `json:"series_total,omitempty" toon:"series_total,omitempty"`
}

DiagnoseMethodSummary is generated from the Flashduty OpenAPI schema.

type DiagnoseMetricTrendResponse added in v0.5.7 

type DiagnoseMetricTrendResponse struct {
	// Data source name.
	DsName string `json:"ds_name" toon:"ds_name"`
	// Data source type.
	DsType string `json:"ds_type" toon:"ds_type"`
	// Diagnostic operation that produced the result. Always `metric_trends`, the metric-trend diagnostic (for `prometheus`-compatible datasources).
	Operation string `json:"operation" toon:"operation"`
	// Query string echoed from the request.
	Query string `json:"query" toon:"query"`
	// Diagnostic evidence from one method; `method` determines the schema of the remaining fields.
	Results []DiagnoseResult `json:"results" toon:"results"`
	// Schema version of the edge diagnostic result. Fixed at `2`, identifying the response-structure version; bumped on incompatible structural changes.
	SchemaVersion string `json:"schema_version" toon:"schema_version"`
	// Current analysis window using RFC 3339 UTC timestamps.
	Window DiagnoseEvidenceWindow `json:"window" toon:"window"`
}

DiagnoseMetricTrendResponse is generated from the Flashduty OpenAPI schema.

type DiagnoseMetricTrendResult added in v0.5.7 

type DiagnoseMetricTrendResult struct {
	// Baseline window kind used by a comparison method. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days. Only present on `window_compare` results.
	Baseline *string `json:"baseline,omitempty" toon:"baseline,omitempty"`
	// Baseline time window used by a comparison method.
	BaselineWindow *DiagnoseEvidenceWindow `json:"baseline_window,omitempty" toon:"baseline_window,omitempty"`
	// Diagnostic method that produced this evidence. `single_window_shape` = within-window trend/shape analysis only, no baseline involved; `window_compare` = per-series comparison between the current window and the baseline window (see `baseline`).
	Method string `json:"method" toon:"method"`
	// Metric evidence for each returned series.
	SeriesEvidence []MetricTrendSeriesEvidence `json:"series_evidence" toon:"series_evidence"`
	Summary        DiagnoseMethodSummary       `json:"summary" toon:"summary"`
	// Non-fatal warnings produced during analysis.
	Warnings []string `json:"warnings" toon:"warnings"`
	// Current analysis window using RFC 3339 UTC timestamps.
	Window DiagnoseEvidenceWindow `json:"window" toon:"window"`
}

DiagnoseMetricTrendResult is generated from the Flashduty OpenAPI schema.

type DiagnoseRequest 

type DiagnoseRequest struct {
	// Optional consistency check. Must equal the authenticated account when supplied.
	AccountID int64 `json:"account_id,omitempty" toon:"account_id,omitempty"`
	// Data source name configured under the tenant.
	DsName string `json:"ds_name" toon:"ds_name"`
	// Data source type. `log_patterns` supports `loki` and `victorialogs`; `metric_trends` supports `prometheus`.
	DsType string `json:"ds_type" toon:"ds_type"`
	// Diagnose input. `query` is required: LogQL / VictoriaLogs query syntax for `log_patterns`; PromQL for `metric_trends`.
	Input DiagnoseRequestInput `json:"input" toon:"input"`
	// Diagnostic methods to run. When omitted, `log_patterns` defaults to `pattern_snapshot + pattern_compare(previous_window)` and `metric_trends` defaults to `single_window_shape + window_compare(previous_window)`.
	Methods []DiagnoseRequestMethodsItem `json:"methods,omitempty" toon:"methods,omitempty"`
	// Diagnostic operation. When omitted, inferred from `ds_type` (loki / victorialogs → `log_patterns`, prometheus → `metric_trends`). Other sources must specify explicitly.
	Operation string `json:"operation,omitempty" toon:"operation,omitempty"`
	// Execution options, all upper-bounded by monit-edge.
	Options DiagnoseRequestOptions `json:"options,omitzero" toon:"options,omitempty"`
	// Diagnostic window in Unix seconds. Defaults to the last 15 minutes when missing or invalid; windows wider than 6 hours are rejected.
	TimeRange DiagnoseRequestTimeRange `json:"time_range,omitzero" toon:"time_range,omitempty"`
}

DiagnoseRequest is generated from the Flashduty OpenAPI schema.

type DiagnoseRequestInput 

type DiagnoseRequestInput struct {
	// Query expression. LogQL / VictoriaLogs query syntax for `log_patterns`; PromQL for `metric_trends`.
	Query string `json:"query" toon:"query"`
}

DiagnoseRequestInput is generated from the Flashduty OpenAPI schema.

type DiagnoseRequestMethodsItem 

type DiagnoseRequestMethodsItem struct {
	// Only meaningful for compare-style methods. Defaults to `previous_window`. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days.
	Baseline string `json:"baseline,omitempty" toon:"baseline,omitempty"`
	// `log_patterns` supports `pattern_snapshot`, `pattern_compare`. `metric_trends` supports `single_window_shape`, `window_compare`.
	Name string `json:"name,omitempty" toon:"name,omitempty"`
}

DiagnoseRequestMethodsItem is generated from the Flashduty OpenAPI schema.

type DiagnoseRequestOptions 

type DiagnoseRequestOptions struct {
	// Max redacted examples per pattern. Default 2, hard max 3.
	ExamplesPerPattern int64 `json:"examples_per_pattern,omitempty" toon:"examples_per_pattern,omitempty"`
	// Per-window log scan cap. Default 10 000, hard max 50 000.
	MaxLogsScanned int64 `json:"max_logs_scanned,omitempty" toon:"max_logs_scanned,omitempty"`
	// Max patterns returned. Default 20, hard max 50.
	MaxPatterns int64 `json:"max_patterns,omitempty" toon:"max_patterns,omitempty"`
	// `metric_trends` max series considered. Default 50, hard max 200.
	MaxSeries int64 `json:"max_series,omitempty" toon:"max_series,omitempty"`
	// `metric_trends` query_range step. Default 60, range [15, 300].
	StepSeconds int64 `json:"step_seconds,omitempty" toon:"step_seconds,omitempty"`
	// Edge-side diagnostic timeout in seconds. Default 25, hard max 30.
	TimeoutSeconds int64 `json:"timeout_seconds,omitempty" toon:"timeout_seconds,omitempty"`
	// `metric_trends` max notable series returned. Default 10, hard max 50.
	Topk int64 `json:"topk,omitempty" toon:"topk,omitempty"`
}

DiagnoseRequestOptions is generated from the Flashduty OpenAPI schema.

type DiagnoseRequestTimeRange 

type DiagnoseRequestTimeRange struct {
	// Window end, Unix seconds.
	End int64 `json:"end,omitempty" toon:"end,omitempty"`
	// Window start, Unix seconds.
	Start int64 `json:"start,omitempty" toon:"start,omitempty"`
}

DiagnoseRequestTimeRange is generated from the Flashduty OpenAPI schema.

type DiagnoseResponse 

type DiagnoseResponse struct {
	DataHandling *DiagnoseLogDataHandling `json:"data_handling,omitempty" toon:"data_handling,omitempty"`
	// Data source name.
	DsName string `json:"ds_name" toon:"ds_name"`
	// Data source type.
	DsType string `json:"ds_type" toon:"ds_type"`
	// Diagnostic operation that produced the result. Always `metric_trends`, the metric-trend diagnostic (for `prometheus`-compatible datasources).
	Operation string `json:"operation" toon:"operation"`
	// Query string echoed from the request.
	Query string `json:"query" toon:"query"`
	// Diagnostic evidence from one method; `method` determines the schema of the remaining fields.
	Results []DiagnoseResult `json:"results" toon:"results"`
	// Schema version of the edge diagnostic result. Fixed at `2`, identifying the response-structure version; bumped on incompatible structural changes.
	SchemaVersion string `json:"schema_version" toon:"schema_version"`
	// Current analysis window using RFC 3339 UTC timestamps.
	Window DiagnoseEvidenceWindow `json:"window" toon:"window"`
}

DiagnoseResponse is generated from the Flashduty OpenAPI schema.

type DiagnoseResult added in v0.5.7 

type DiagnoseResult struct {
	// Baseline window kind used by a comparison method. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days. Only present on `window_compare` results.
	Baseline *string `json:"baseline,omitempty" toon:"baseline,omitempty"`
	// Baseline time window used by a comparison method.
	BaselineWindow *DiagnoseEvidenceWindow `json:"baseline_window,omitempty" toon:"baseline_window,omitempty"`
	// Diagnostic method that produced this evidence. `single_window_shape` = within-window trend/shape analysis only, no baseline involved; `window_compare` = per-series comparison between the current window and the baseline window (see `baseline`).
	Method string `json:"method" toon:"method"`
	// Log-pattern evidence ordered for RCA use.
	PatternEvidence *[]LogPatternEvidence `json:"pattern_evidence,omitempty" toon:"pattern_evidence,omitempty"`
	// Metric evidence for each returned series.
	SeriesEvidence *[]MetricTrendSeriesEvidence `json:"series_evidence,omitempty" toon:"series_evidence,omitempty"`
	Summary        DiagnoseMethodSummary        `json:"summary" toon:"summary"`
	// Non-fatal warnings produced during analysis.
	Warnings []string `json:"warnings" toon:"warnings"`
	// Current analysis window using RFC 3339 UTC timestamps.
	Window DiagnoseEvidenceWindow `json:"window" toon:"window"`
}

DiagnoseResult is generated from the Flashduty OpenAPI schema.

type DiagnosticsService 

type DiagnosticsService service

DiagnosticsService handles the "Monitors/Diagnostics" API resource.

func (*DiagnosticsService) QueryData added in v0.13.1 

func (s *DiagnosticsService) QueryData(ctx context.Context, req *QueryDataRequest) (*QueryDataResponse, *Response, error)

Query structured data.

Run a synchronous ad-hoc query against a configured data source and return a stable `query_result.v1` result whose natural shape is frames, records, or samples. This public API requires monit-edge v0.65.0 or later.

API: POST /monit/query/data (monit-read-query-data).

func (*DiagnosticsService) QueryDiagnose deprecated 

func (s *DiagnosticsService) QueryDiagnose(ctx context.Context, req *DiagnoseRequest) (*DiagnoseResponse, *Response, error)

Diagnose data source.

Run a synchronous diagnostic query (`log_patterns` for Loki/VictoriaLogs, `metric_trends` for Prometheus). Used by Flashduty AI SRE for log-pattern clustering and time-series trend analysis. Long-running — up to 35 s.

Deprecated: migrate to /monit/datasource/tools/invoke with prometheus.metric_trends, loki.log_patterns or victorialogs.log_patterns. Retained for existing consumers; the legacy request and response remain unchanged.

API: POST /monit/query/diagnose (monit-read-query-diagnose).

func (*DiagnosticsService) TargetsList 

func (s *DiagnosticsService) TargetsList(ctx context.Context, req *TargetsListRequest) (*TargetsListResponse, *Response, error)

List monitored targets.

List the targets observed under the current tenant by the monit-agent route projection. Supports `target_locator` prefix search and cursor pagination. Use this to drive `target_locator` selection for `/monit/tools/catalog` and `/monit/tools/invoke`. Agent targets are host-only. Remote datasource evidence uses /monit/datasource/tools/invoke and datasource_id.

API: POST /monit/targets (monit-read-targets-list).

func (*DiagnosticsService) ToolsCatalog 

func (s *DiagnosticsService) ToolsCatalog(ctx context.Context, req *ToolCatalogRequest) (*ToolCatalogResponse, *Response, error)

List target tool catalog.

Look up the tools that the per-target monit-agent currently exposes for a given `target_locator` (host). Returns each tool's name, description, and JSON-Schema `input_schema`. Pair with `/monit/tools/invoke` to drive AI-SRE tool calls. Agent targets are host-only. Remote datasource evidence uses /monit/datasource/tools/invoke and datasource_id.

API: POST /monit/tools/catalog (monit-read-tools-catalog).

func (*DiagnosticsService) ToolsInvoke 

func (s *DiagnosticsService) ToolsInvoke(ctx context.Context, req *ToolInvokeRequest) (*ToolInvokeResponse, *Response, error)

Invoke target tools.

Invoke up to 8 monit-agent tools concurrently on a single target. Results come back in the order of the input `tools` array. Long-running — individual tools have per-tool timeouts on the agent and the whole request may take tens of seconds. Agent targets are host-only. Remote datasource evidence uses /monit/datasource/tools/invoke and datasource_id.

API: POST /monit/tools/invoke (monit-read-tools-invoke).

type DimensionInsightItem 

type DimensionInsightItem struct {
	// Acknowledgement rate (%): acknowledged incidents ÷ total incidents × 100, rounded to two decimals and capped at 100; 0 when the bucket has no incidents.
	AcknowledgementPct float64 `json:"acknowledgement_pct" toon:"acknowledgement_pct"`
	// Channel ID, returned only when aggregating by channel (`/insight/channel`).
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel name, returned when aggregating by channel; omitted when the name cannot be resolved.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Hour bucket when `split_hours` is enabled. `work` is Mon–Fri 08:00–19:00, `sleep` is daily 23:00–08:00, and `off` is everything else, all evaluated in the account timezone (`sleep` takes precedence over `work`). Omitted when `split_hours` is false.
	Hours string `json:"hours" toon:"hours"`
	// Mean time to first acknowledgement in seconds; 0 when no incident in the bucket was acknowledged.
	MeanSecondsToAck float64 `json:"mean_seconds_to_ack" toon:"mean_seconds_to_ack"`
	// Mean time to close in seconds; 0 when no incident in the bucket was closed.
	MeanSecondsToClose float64 `json:"mean_seconds_to_close" toon:"mean_seconds_to_close"`
	// Noise reduction ratio (%): 100 − incidents ÷ alert events × 100, rounded to two decimals; 0 when there is no alert-event data or alert events do not exceed incidents.
	NoiseReductionPct float64 `json:"noise_reduction_pct" toon:"noise_reduction_pct"`
	// Responder (person) ID, returned only when aggregating by responder (`/insight/responder`).
	ResponderID int64 `json:"responder_id" toon:"responder_id"`
	// Responder name, returned when aggregating by responder; omitted when the name cannot be resolved.
	ResponderName string `json:"responder_name" toon:"responder_name"`
	// Team ID, returned only when aggregating by team (`/insight/team`).
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Team name, returned when aggregating by team; omitted when the name cannot be resolved (e.g. team deleted).
	TeamName string `json:"team_name" toon:"team_name"`
	// Total number of alerts.
	TotalAlertCnt int64 `json:"total_alert_cnt" toon:"total_alert_cnt"`
	// Total number of alert events.
	TotalAlertEventCnt int64 `json:"total_alert_event_cnt" toon:"total_alert_event_cnt"`
	// Total engaged time in seconds: each incident contributes the sum of close time minus acknowledgement time across its acknowledged responders.
	TotalEngagedSeconds int64 `json:"total_engaged_seconds" toon:"total_engaged_seconds"`
	// Total number of incidents.
	TotalIncidentCnt int64 `json:"total_incident_cnt" toon:"total_incident_cnt"`
	// Incidents that were acknowledged at least once.
	TotalIncidentsAcknowledged int64 `json:"total_incidents_acknowledged" toon:"total_incidents_acknowledged"`
	// Incidents closed automatically because all alerts recovered.
	TotalIncidentsAutoClosed int64 `json:"total_incidents_auto_closed" toon:"total_incidents_auto_closed"`
	// Incidents that are closed.
	TotalIncidentsClosed int64 `json:"total_incidents_closed" toon:"total_incidents_closed"`
	// Incidents that were escalated at least once.
	TotalIncidentsEscalated int64 `json:"total_incidents_escalated" toon:"total_incidents_escalated"`
	// Incidents closed manually.
	TotalIncidentsManuallyClosed int64 `json:"total_incidents_manually_closed" toon:"total_incidents_manually_closed"`
	// Incidents escalated manually at least once.
	TotalIncidentsManuallyEscalated int64 `json:"total_incidents_manually_escalated" toon:"total_incidents_manually_escalated"`
	// Incidents that were reassigned at least once.
	TotalIncidentsReassigned int64 `json:"total_incidents_reassigned" toon:"total_incidents_reassigned"`
	// Incidents closed automatically on timeout.
	TotalIncidentsTimeoutClosed int64 `json:"total_incidents_timeout_closed" toon:"total_incidents_timeout_closed"`
	// Incidents escalated on timeout at least once.
	TotalIncidentsTimeoutEscalated int64 `json:"total_incidents_timeout_escalated" toon:"total_incidents_timeout_escalated"`
	// Total interruptions: notifications sent via app push, SMS, or voice call; consecutive notifications to the same responder within 60 seconds count as one.
	TotalInterruptions int64 `json:"total_interruptions" toon:"total_interruptions"`
	// Total number of notifications sent.
	TotalNotifications int64 `json:"total_notifications" toon:"total_notifications"`
	// Total time to first acknowledgement in seconds.
	TotalSecondsToAck int64 `json:"total_seconds_to_ack" toon:"total_seconds_to_ack"`
	// Total time to close in seconds.
	TotalSecondsToClose int64 `json:"total_seconds_to_close" toon:"total_seconds_to_close"`
	// Start of the aggregation bucket, Unix epoch seconds. Equals `start_time` when no `aggregate_unit` is given.
	TS Timestamp `json:"ts" toon:"ts"`
}

DimensionInsightItem is generated from the Flashduty OpenAPI schema.

type DimensionInsightResponse 

type DimensionInsightResponse struct {
	// Insight metric rows aggregated by the endpoint's dimension (account/team/channel); further split by hour bucket or time bucket when `split_hours` or `aggregate_unit` is enabled.
	Items []DimensionInsightItem `json:"items" toon:"items"`
}

DimensionInsightResponse is generated from the Flashduty OpenAPI schema.

type DisableIncidentMergeRequest 

type DisableIncidentMergeRequest struct {
	// Incident IDs whose automatic merge should be disabled.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
}

DisableIncidentMergeRequest is generated from the Flashduty OpenAPI schema.

type DoIncidentCustomActionRequest 

type DoIncidentCustomActionRequest struct {
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Custom action integration ID. Must be enabled and associated with the incident's channel.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
}

DoIncidentCustomActionRequest is generated from the Flashduty OpenAPI schema.

type DoIncidentCustomActionResponse 

type DoIncidentCustomActionResponse struct {
	// Error message if the action's HTTP call failed; omitted on success.
	Message string `json:"message" toon:"message"`
}

DoIncidentCustomActionResponse is generated from the Flashduty OpenAPI schema.

type DsClickHouseConfig 

type DsClickHouseConfig struct {
	// Default database for authentication.
	Database string `json:"database,omitempty" toon:"database,omitempty"`
	// Dial timeout in milliseconds.
	DialTimeoutMills int64 `json:"dial_timeout_mills,omitempty" toon:"dial_timeout_mills,omitempty"`
	// Maximum number of idle connections in the pool; `0` or omitted uses the default of 4.
	IdleConns int64 `json:"idle_conns,omitempty" toon:"idle_conns,omitempty"`
	// Maximum connection lifetime in seconds; `0` or omitted uses the default of 600 (10 minutes).
	LifetimeSeconds int64 `json:"lifetime_seconds,omitempty" toon:"lifetime_seconds,omitempty"`
	// Max query execution time in seconds.
	MaxExecutionSeconds int64 `json:"max_execution_seconds,omitempty" toon:"max_execution_seconds,omitempty"`
	// Maximum number of open connections in the pool; `0` or omitted uses the default of 32.
	OpenConns int64 `json:"open_conns,omitempty" toon:"open_conns,omitempty"`
	// ClickHouse authentication password.
	Password string `json:"password,omitempty" toon:"password,omitempty"`
	// Per-query timeout in milliseconds; `0` or omitted uses the default of 10000 (10 seconds).
	TimeoutMills int64 `json:"timeout_mills,omitempty" toon:"timeout_mills,omitempty"`
	// PEM-encoded CA certificate used to verify the server certificate.
	TlsCa string `json:"tls_ca,omitempty" toon:"tls_ca,omitempty"`
	// PEM-encoded client certificate for mutual TLS; must be configured together with `tls_key`.
	TlsCert string `json:"tls_cert,omitempty" toon:"tls_cert,omitempty"`
	// Whether TLS is enabled; when `false`, all `tls_*` fields are cleared before saving.
	TlsEnabled bool `json:"tls_enabled,omitempty" toon:"tls_enabled,omitempty"`
	// PEM-encoded client private key; must be configured together with `tls_cert`.
	TlsKey string `json:"tls_key,omitempty" toon:"tls_key,omitempty"`
	// Maximum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint.
	TlsMaxVersion string `json:"tls_max_version,omitempty" toon:"tls_max_version,omitempty"`
	// Minimum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint and it must not exceed `tls_max_version`.
	TlsMinVersion string `json:"tls_min_version,omitempty" toon:"tls_min_version,omitempty"`
	// Server name used for TLS SNI and certificate verification; defaults to the host from the connection address when empty.
	TlsServerName string `json:"tls_server_name,omitempty" toon:"tls_server_name,omitempty"`
	// Whether to skip server certificate verification (insecure, for self-signed setups only).
	TlsSkipVerify bool `json:"tls_skip_verify,omitempty" toon:"tls_skip_verify,omitempty"`
	// ClickHouse authentication username.
	Username string `json:"username,omitempty" toon:"username,omitempty"`
}

DsClickHouseConfig is generated from the Flashduty OpenAPI schema.

type DsElasticSearchConfig 

type DsElasticSearchConfig struct {
	// Elastic Cloud API key. Only for `cloud` deployment.
	APIKey string `json:"api_key,omitempty" toon:"api_key,omitempty"`
	// SHA-256 fingerprint of the Elasticsearch CA certificate, used to verify the server chain (the recommended check for ES 8 default security).
	CertificateFingerprint string `json:"certificate_fingerprint,omitempty" toon:"certificate_fingerprint,omitempty"`
	// Elastic Cloud deployment ID. Only for `cloud` deployment.
	CloudID string `json:"cloud_id,omitempty" toon:"cloud_id,omitempty"`
	// Deployment type. `cloud` uses Elastic Cloud; `self-managed` uses a self-hosted cluster.
	Deployment string `json:"deployment,omitempty" toon:"deployment,omitempty"`
	// Custom HTTP headers added to every request, each entry formatted as `Key: Value`.
	Headers []string `json:"headers,omitempty" toon:"headers,omitempty"`
	// Authentication password for self-managed clusters; ignored when `service_token` is set.
	Password string `json:"password,omitempty" toon:"password,omitempty"`
	// Service token; overrides username/password if set.
	ServiceToken string `json:"service_token,omitempty" toon:"service_token,omitempty"`
	// Per-query timeout in milliseconds; `0` or omitted uses the default of 10000 (10 seconds).
	TimeoutMills int64 `json:"timeout_mills,omitempty" toon:"timeout_mills,omitempty"`
	// PEM-encoded CA certificate used to verify the Elasticsearch server certificate.
	TlsCa string `json:"tls_ca,omitempty" toon:"tls_ca,omitempty"`
	// Username for `self-managed` deployment.
	Username string `json:"username,omitempty" toon:"username,omitempty"`
}

DsElasticSearchConfig is generated from the Flashduty OpenAPI schema.

type DsKafkaConfig added in v0.15.0 

type DsKafkaConfig struct {
	// Authentication password; supports ${env:NAME}. Omit on update to preserve; explicitly send an empty string to clear. Literal passwords are omitted from responses.
	Password *string `json:"password,omitempty" toon:"password,omitempty"`
	// SASL mechanism: none (default, no credentials), plain, scram-sha-256, scram-sha-512 (require username and password).
	SaslMechanism string `json:"sasl_mechanism,omitempty" toon:"sasl_mechanism,omitempty"`
	// Connection timeout in milliseconds; defaults to 5000 when omitted.
	TimeoutMs int64 `json:"timeout_ms,omitempty" toon:"timeout_ms,omitempty"`
	// PEM CA certificates or an ${env:NAME} reference.
	TlsCa string `json:"tls_ca,omitempty" toon:"tls_ca,omitempty"`
	// PEM client certificate or ${env:NAME}; configure both tls_cert and tls_key.
	TlsCert string `json:"tls_cert,omitempty" toon:"tls_cert,omitempty"`
	// Whether TLS is enabled; defaults to false.
	TlsEnabled bool `json:"tls_enabled,omitempty" toon:"tls_enabled,omitempty"`
	// PEM client private key or ${env:NAME}; configure both tls_cert and tls_key. Omit on update to preserve; an empty string clears it. Literal keys are omitted from responses.
	TlsKey *string `json:"tls_key,omitempty" toon:"tls_key,omitempty"`
	// Maximum TLS version: 1.2 or 1.3; empty means no constraint. Must not be below the minimum.
	TlsMaxVersion string `json:"tls_max_version,omitempty" toon:"tls_max_version,omitempty"`
	// Minimum TLS version: 1.2 (default) or 1.3.
	TlsMinVersion string `json:"tls_min_version,omitempty" toon:"tls_min_version,omitempty"`
	// Server name used for TLS SNI and certificate verification; defaults to the host from the connection address when empty.
	TlsServerName string `json:"tls_server_name,omitempty" toon:"tls_server_name,omitempty"`
	// Skip server certificate verification when TLS is enabled.
	TlsSkipVerify bool `json:"tls_skip_verify,omitempty" toon:"tls_skip_verify,omitempty"`
	// Authentication username; an ${env:NAME} reference is supported.
	Username string `json:"username,omitempty" toon:"username,omitempty"`
}

DsKafkaConfig is generated from the Flashduty OpenAPI schema.

type DsLokiConfig 

type DsLokiConfig struct {
	// Whether HTTP Basic Auth is enabled; when `false`, `basic_auth_username`/`basic_auth_password` are ignored.
	BasicAuthEnabled bool `json:"basic_auth_enabled,omitempty" toon:"basic_auth_enabled,omitempty"`
	// Basic Auth password, effective when `basic_auth_enabled` is `true`.
	BasicAuthPassword string `json:"basic_auth_password,omitempty" toon:"basic_auth_password,omitempty"`
	// Basic Auth username, effective when `basic_auth_enabled` is `true`.
	BasicAuthUsername string `json:"basic_auth_username,omitempty" toon:"basic_auth_username,omitempty"`
	// Custom HTTP headers added to every request, each entry formatted as `Key: Value`; usable for tenancy headers such as `X-Scope-OrgID`.
	Headers []string `json:"headers,omitempty" toon:"headers,omitempty"`
	// Custom query parameters appended to every request URL, each entry formatted as `key=value`.
	Params []string `json:"params,omitempty" toon:"params,omitempty"`
	// PEM-encoded CA certificate used to verify the server certificate.
	TlsCa string `json:"tls_ca,omitempty" toon:"tls_ca,omitempty"`
	// PEM-encoded client certificate for mutual TLS; must be configured together with `tls_key`.
	TlsCert string `json:"tls_cert,omitempty" toon:"tls_cert,omitempty"`
	// PEM-encoded client private key; must be configured together with `tls_cert`.
	TlsKey string `json:"tls_key,omitempty" toon:"tls_key,omitempty"`
	// Maximum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint.
	TlsMaxVersion string `json:"tls_max_version,omitempty" toon:"tls_max_version,omitempty"`
	// Minimum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint and it must not exceed `tls_max_version`.
	TlsMinVersion string `json:"tls_min_version,omitempty" toon:"tls_min_version,omitempty"`
	// Server name used for TLS SNI and certificate verification; defaults to the host from the connection address when empty.
	TlsServerName string `json:"tls_server_name,omitempty" toon:"tls_server_name,omitempty"`
	// Whether to skip server certificate verification (insecure, for self-signed setups only).
	TlsSkipVerify bool `json:"tls_skip_verify,omitempty" toon:"tls_skip_verify,omitempty"`
}

DsLokiConfig is generated from the Flashduty OpenAPI schema.

type DsMongoDBConfig added in v0.15.0 

type DsMongoDBConfig struct {
	// Authentication database; defaults to admin. Username and password must be configured together. Client certificates are unsupported.
	AuthSource string `json:"auth_source,omitempty" toon:"auth_source,omitempty"`
	// Authentication password; supports ${env:NAME}. Omit on update to preserve; explicitly send an empty string to clear. Literal passwords are omitted from responses.
	Password *string `json:"password,omitempty" toon:"password,omitempty"`
	// Connection timeout in milliseconds; defaults to 3000 when omitted.
	TimeoutMs int64 `json:"timeout_ms,omitempty" toon:"timeout_ms,omitempty"`
	// PEM CA certificates or an ${env:NAME} reference.
	TlsCa string `json:"tls_ca,omitempty" toon:"tls_ca,omitempty"`
	// Whether TLS is enabled; defaults to false.
	TlsEnabled bool `json:"tls_enabled,omitempty" toon:"tls_enabled,omitempty"`
	// Maximum TLS version: 1.2 or 1.3; empty means no constraint. Must not be below the minimum.
	TlsMaxVersion string `json:"tls_max_version,omitempty" toon:"tls_max_version,omitempty"`
	// Minimum TLS version: 1.2 (default) or 1.3.
	TlsMinVersion string `json:"tls_min_version,omitempty" toon:"tls_min_version,omitempty"`
	// Server name used for TLS SNI and certificate verification; defaults to the host from the connection address when empty.
	TlsServerName string `json:"tls_server_name,omitempty" toon:"tls_server_name,omitempty"`
	// Skip server certificate verification when TLS is enabled.
	TlsSkipVerify bool `json:"tls_skip_verify,omitempty" toon:"tls_skip_verify,omitempty"`
	// Authentication username; an ${env:NAME} reference is supported.
	Username string `json:"username,omitempty" toon:"username,omitempty"`
}

DsMongoDBConfig is generated from the Flashduty OpenAPI schema.

type DsMySqlConfig 

type DsMySqlConfig struct {
	// Maximum idle connections.
	IdleConns int64 `json:"idle_conns,omitempty" toon:"idle_conns,omitempty"`
	// Connection maximum lifetime in seconds.
	LifetimeSeconds int64 `json:"lifetime_seconds,omitempty" toon:"lifetime_seconds,omitempty"`
	// Maximum open connections.
	OpenConns int64 `json:"open_conns,omitempty" toon:"open_conns,omitempty"`
	// MySQL authentication password.
	Password string `json:"password,omitempty" toon:"password,omitempty"`
	// Query timeout in milliseconds.
	TimeoutMills int64 `json:"timeout_mills,omitempty" toon:"timeout_mills,omitempty"`
	// PEM-encoded CA certificate used to verify the server certificate; only allowed when `tls_mode` is `verify-full` (or empty legacy mode).
	TlsCa string `json:"tls_ca,omitempty" toon:"tls_ca,omitempty"`
	// PEM-encoded client certificate for mutual TLS; must be configured together with `tls_key`.
	TlsCert string `json:"tls_cert,omitempty" toon:"tls_cert,omitempty"`
	// PEM-encoded client private key; must be configured together with `tls_cert`.
	TlsKey string `json:"tls_key,omitempty" toon:"tls_key,omitempty"`
	// Maximum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint.
	TlsMaxVersion string `json:"tls_max_version,omitempty" toon:"tls_max_version,omitempty"`
	// Minimum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint and it must not exceed `tls_max_version`.
	TlsMinVersion string `json:"tls_min_version,omitempty" toon:"tls_min_version,omitempty"`
	// TLS mode for the MySQL connection. Empty keeps the legacy per-field TLS behavior. `disable` = no TLS (all `tls_*` fields are cleared on save); `require` = TLS without server certificate verification; `verify-full` = TLS with full server verification (CA chain and hostname). MySQL has no `verify-ca` — verifying the CA implies verifying the hostname.
	TlsMode string `json:"tls_mode,omitempty" toon:"tls_mode,omitempty"`
	// Server name used for TLS SNI and certificate verification; defaults to the host from the connection address when empty.
	TlsServerName string `json:"tls_server_name,omitempty" toon:"tls_server_name,omitempty"`
	// Whether to skip server certificate verification; derived from `tls_mode` when set (`require` → `true`, `verify-full` → `false`) — only manually effective under legacy empty `tls_mode`.
	TlsSkipVerify bool `json:"tls_skip_verify,omitempty" toon:"tls_skip_verify,omitempty"`
	// MySQL authentication username.
	Username string `json:"username,omitempty" toon:"username,omitempty"`
}

DsMySqlConfig is generated from the Flashduty OpenAPI schema.

type DsOracleConfig 

type DsOracleConfig struct {
	// Maximum number of idle connections in the pool; `0` or omitted uses the default of 4.
	IdleConns int64 `json:"idle_conns,omitempty" toon:"idle_conns,omitempty"`
	// Maximum connection lifetime in seconds; `0` or omitted uses the default of 600 (10 minutes).
	LifetimeSeconds int64 `json:"lifetime_seconds,omitempty" toon:"lifetime_seconds,omitempty"`
	// Maximum number of open connections in the pool; `0` or omitted uses the default of 32.
	OpenConns int64 `json:"open_conns,omitempty" toon:"open_conns,omitempty"`
	// Extra connection options as key-value pairs.
	Options map[string]string `json:"options,omitempty" toon:"options,omitempty"`
	// Oracle authentication password.
	Password string `json:"password,omitempty" toon:"password,omitempty"`
	// Per-query timeout in milliseconds; `0` or omitted uses the default of 10000 (10 seconds).
	TimeoutMills int64 `json:"timeout_mills,omitempty" toon:"timeout_mills,omitempty"`
	// Oracle authentication username.
	Username string `json:"username,omitempty" toon:"username,omitempty"`
}

DsOracleConfig is generated from the Flashduty OpenAPI schema.

type DsPayload 

type DsPayload struct {
	Clickhouse    DsClickHouseConfig     `json:"clickhouse,omitzero" toon:"clickhouse,omitempty"`
	Elasticsearch DsElasticSearchConfig  `json:"elasticsearch,omitzero" toon:"elasticsearch,omitempty"`
	Kafka         *DsKafkaConfig         `json:"kafka,omitempty" toon:"kafka,omitempty"`
	Loki          DsLokiConfig           `json:"loki,omitzero" toon:"loki,omitempty"`
	MongodbMongod *DsMongoDBConfig       `json:"mongodb_mongod,omitempty" toon:"mongodb_mongod,omitempty"`
	MongodbMongos *DsMongoDBConfig       `json:"mongodb_mongos,omitempty" toon:"mongodb_mongos,omitempty"`
	Mysql         DsMySqlConfig          `json:"mysql,omitzero" toon:"mysql,omitempty"`
	Oracle        DsOracleConfig         `json:"oracle,omitzero" toon:"oracle,omitempty"`
	Postgres      DsPostgresConfig       `json:"postgres,omitzero" toon:"postgres,omitempty"`
	Prometheus    DsPrometheusConfig     `json:"prometheus,omitzero" toon:"prometheus,omitempty"`
	RedisNode     *DsRedisNodeConfig     `json:"redis_node,omitempty" toon:"redis_node,omitempty"`
	RedisSentinel *DsRedisSentinelConfig `json:"redis_sentinel,omitempty" toon:"redis_sentinel,omitempty"`
	SLS           DsslsConfig            `json:"sls,omitzero" toon:"sls,omitempty"`
	// Tencent CLS credentials. Required when `type_ident` is `tencent_cls`.
	TencentCls   DsTencentClsConfig   `json:"tencent_cls,omitzero" toon:"tencent_cls,omitempty"`
	Victorialogs DsVictoriaLogsConfig `json:"victorialogs,omitzero" toon:"victorialogs,omitempty"`
}

DsPayload is generated from the Flashduty OpenAPI schema.

type DsPostgresConfig 

type DsPostgresConfig struct {
	// Maximum number of idle connections in the pool; `0` or omitted uses the default of 4.
	IdleConns int64 `json:"idle_conns,omitempty" toon:"idle_conns,omitempty"`
	// Maximum connection lifetime in seconds; `0` or omitted uses the default of 600 (10 minutes).
	LifetimeSeconds int64 `json:"lifetime_seconds,omitempty" toon:"lifetime_seconds,omitempty"`
	// Maximum number of open connections in the pool; `0` or omitted uses the default of 32.
	OpenConns int64 `json:"open_conns,omitempty" toon:"open_conns,omitempty"`
	// PostgreSQL authentication password.
	Password string `json:"password,omitempty" toon:"password,omitempty"`
	// SSL mode for the PostgreSQL connection. Empty keeps the legacy behavior inferred from `tls_ca`. `disable` = no TLS (all `tls_*` fields are cleared on save); `require` = TLS without server certificate verification (`tls_ca` not allowed); `verify-ca` = verify the server certificate CA chain but not the hostname; `verify-full` = verify both CA chain and hostname.
	SslMode string `json:"ssl_mode,omitempty" toon:"ssl_mode,omitempty"`
	// Per-query timeout in milliseconds; `0` or omitted uses the default of 10000 (10 seconds).
	TimeoutMills int64 `json:"timeout_mills,omitempty" toon:"timeout_mills,omitempty"`
	// PEM-encoded CA certificate used to verify the server certificate; used with `ssl_mode` `verify-ca`/`verify-full` and rejected under `require`.
	TlsCa string `json:"tls_ca,omitempty" toon:"tls_ca,omitempty"`
	// PEM-encoded client certificate for mutual TLS; must be configured together with `tls_key`.
	TlsCert string `json:"tls_cert,omitempty" toon:"tls_cert,omitempty"`
	// PEM-encoded client private key; must be configured together with `tls_cert`.
	TlsKey string `json:"tls_key,omitempty" toon:"tls_key,omitempty"`
	// PostgreSQL authentication username.
	Username string `json:"username,omitempty" toon:"username,omitempty"`
}

DsPostgresConfig is generated from the Flashduty OpenAPI schema.

type DsPrometheusConfig 

type DsPrometheusConfig struct {
	// Enable HTTP Basic Auth.
	BasicAuthEnabled bool `json:"basic_auth_enabled,omitempty" toon:"basic_auth_enabled,omitempty"`
	// Basic auth password.
	BasicAuthPassword string `json:"basic_auth_password,omitempty" toon:"basic_auth_password,omitempty"`
	// Basic auth username.
	BasicAuthUsername string `json:"basic_auth_username,omitempty" toon:"basic_auth_username,omitempty"`
	// Custom HTTP headers in `Key: Value` format.
	Headers []string `json:"headers,omitempty" toon:"headers,omitempty"`
	// Custom query parameters in `key=value` format.
	Params []string `json:"params,omitempty" toon:"params,omitempty"`
	// PEM-encoded CA certificate used to verify the server certificate.
	TlsCa string `json:"tls_ca,omitempty" toon:"tls_ca,omitempty"`
	// PEM-encoded client certificate for mutual TLS; must be configured together with `tls_key`.
	TlsCert string `json:"tls_cert,omitempty" toon:"tls_cert,omitempty"`
	// PEM-encoded client private key; must be configured together with `tls_cert`.
	TlsKey string `json:"tls_key,omitempty" toon:"tls_key,omitempty"`
	// Maximum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint.
	TlsMaxVersion string `json:"tls_max_version,omitempty" toon:"tls_max_version,omitempty"`
	// Minimum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint and it must not exceed `tls_max_version`.
	TlsMinVersion string `json:"tls_min_version,omitempty" toon:"tls_min_version,omitempty"`
	// Server name used for TLS SNI and certificate verification; defaults to the host from the connection address when empty.
	TlsServerName string `json:"tls_server_name,omitempty" toon:"tls_server_name,omitempty"`
	// Whether to skip server certificate verification (insecure, for self-signed setups only).
	TlsSkipVerify bool `json:"tls_skip_verify,omitempty" toon:"tls_skip_verify,omitempty"`
}

DsPrometheusConfig is generated from the Flashduty OpenAPI schema.

type DsRedisNodeConfig added in v0.15.0 

type DsRedisNodeConfig struct {
	// Redis database number; defaults to 0.
	Database int64 `json:"database,omitempty" toon:"database,omitempty"`
	// Authentication password; supports ${env:NAME}. Omit on update to preserve; explicitly send an empty string to clear. Literal passwords are omitted from responses.
	Password *string `json:"password,omitempty" toon:"password,omitempty"`
	// Connection timeout in milliseconds; defaults to 3000 when omitted.
	TimeoutMs int64 `json:"timeout_ms,omitempty" toon:"timeout_ms,omitempty"`
	// Authentication username; an ${env:NAME} reference is supported.
	Username string `json:"username,omitempty" toon:"username,omitempty"`
}

DsRedisNodeConfig is generated from the Flashduty OpenAPI schema.

type DsRedisSentinelConfig added in v0.15.0 

type DsRedisSentinelConfig struct {
	// Authentication password; supports ${env:NAME}. Omit on update to preserve; explicitly send an empty string to clear. Literal passwords are omitted from responses.
	Password *string `json:"password,omitempty" toon:"password,omitempty"`
	// Connection timeout in milliseconds; defaults to 3000 when omitted.
	TimeoutMs int64 `json:"timeout_ms,omitempty" toon:"timeout_ms,omitempty"`
	// Authentication username; an ${env:NAME} reference is supported.
	Username string `json:"username,omitempty" toon:"username,omitempty"`
}

DsRedisSentinelConfig is generated from the Flashduty OpenAPI schema.

type DsTencentClsConfig added in v0.14.3 

type DsTencentClsConfig struct {
	// Tencent Cloud API SecretId. Always required (create and update). Supports `${env:VAR}` references resolved on the edge.
	SecretID string `json:"secret_id" toon:"secret_id"`
	// Tencent Cloud API SecretKey. Required on create; on update, omit to keep the stored key. Supports `${env:VAR}` references. Never returned by read APIs: responses carry an empty string unless the stored value is an `${env:...}` reference.
	SecretKey string `json:"secret_key,omitempty" toon:"secret_key,omitempty"`
}

DsTencentClsConfig is generated from the Flashduty OpenAPI schema.

type DsType 

type DsType struct {
	// Owning account ID. `0` for global types.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// ID of the datasource type record.
	ID uint64 `json:"id" toon:"id"`
	// Identifier used as the `ds_type` of rules, e.g. `prometheus`.
	Ident string `json:"ident" toon:"ident"`
	// Display name, e.g. `Prometheus`.
	Name string `json:"name" toon:"name"`
	// Display order weight; higher appears first.
	Weight int64 `json:"weight" toon:"weight"`
}

DsType is generated from the Flashduty OpenAPI schema.

type DsVictoriaLogsConfig 

type DsVictoriaLogsConfig struct {
	// Whether HTTP Basic Auth is enabled; when `false`, `basic_auth_username`/`basic_auth_password` are ignored.
	BasicAuthEnabled bool `json:"basic_auth_enabled,omitempty" toon:"basic_auth_enabled,omitempty"`
	// Basic Auth password, effective when `basic_auth_enabled` is `true`.
	BasicAuthPassword string `json:"basic_auth_password,omitempty" toon:"basic_auth_password,omitempty"`
	// Basic Auth username, effective when `basic_auth_enabled` is `true`.
	BasicAuthUsername string `json:"basic_auth_username,omitempty" toon:"basic_auth_username,omitempty"`
	// Custom HTTP headers added to every request, each entry formatted as `Key: Value`; usable for tenancy headers such as `AccountID`/`ProjectID`.
	Headers []string `json:"headers,omitempty" toon:"headers,omitempty"`
	// Custom query parameters appended to every request URL, each entry formatted as `key=value`.
	Params []string `json:"params,omitempty" toon:"params,omitempty"`
	// PEM-encoded CA certificate used to verify the server certificate.
	TlsCa string `json:"tls_ca,omitempty" toon:"tls_ca,omitempty"`
	// PEM-encoded client certificate for mutual TLS; must be configured together with `tls_key`.
	TlsCert string `json:"tls_cert,omitempty" toon:"tls_cert,omitempty"`
	// PEM-encoded client private key; must be configured together with `tls_cert`.
	TlsKey string `json:"tls_key,omitempty" toon:"tls_key,omitempty"`
	// Maximum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint.
	TlsMaxVersion string `json:"tls_max_version,omitempty" toon:"tls_max_version,omitempty"`
	// Minimum TLS version, one of `1.0`, `1.1`, `1.2`, `1.3`; empty means no constraint and it must not exceed `tls_max_version`.
	TlsMinVersion string `json:"tls_min_version,omitempty" toon:"tls_min_version,omitempty"`
	// Server name used for TLS SNI and certificate verification; defaults to the host from the connection address when empty.
	TlsServerName string `json:"tls_server_name,omitempty" toon:"tls_server_name,omitempty"`
	// Whether to skip server certificate verification (insecure, for self-signed setups only).
	TlsSkipVerify bool `json:"tls_skip_verify,omitempty" toon:"tls_skip_verify,omitempty"`
}

DsVictoriaLogsConfig is generated from the Flashduty OpenAPI schema.

type DsslsConfig 

type DsslsConfig struct {
	// Alibaba Cloud Access Key ID.
	AccessKeyID string `json:"access_key_id,omitempty" toon:"access_key_id,omitempty"`
	// Alibaba Cloud Access Key Secret.
	AccessKeySecret string `json:"access_key_secret,omitempty" toon:"access_key_secret,omitempty"`
	// Custom HTTP headers.
	Headers []string `json:"headers,omitempty" toon:"headers,omitempty"`
}

DsslsConfig is generated from the Flashduty OpenAPI schema.

type DutyError 

type DutyError struct {
	Code    string `json:"code"`
	Reason  string `json:"reason,omitempty"`
	Message string `json:"message"`
}

DutyError is the Flashduty API error object carried inside the response envelope's "error" field.

func (*DutyError) Error 

func (e *DutyError) Error() string

type EmptyObject 

type EmptyObject struct{}

EmptyObject is generated from the Flashduty OpenAPI schema.

type EmptyRequest 

type EmptyRequest struct{}

EmptyRequest is generated from the Flashduty OpenAPI schema.

type EmptyResponse 

type EmptyResponse struct{}

EmptyResponse is generated from the Flashduty OpenAPI schema.

type EnabledTime 

type EnabledTime struct {
	// Days of week, 0 = Sunday.
	Days []int64 `json:"days,omitempty" toon:"days,omitempty"`
	// End time, e.g. `18:00`.
	Etime string `json:"etime,omitempty" toon:"etime,omitempty"`
	// Start time, e.g. `09:00`.
	Stime string `json:"stime,omitempty" toon:"stime,omitempty"`
}

EnabledTime is generated from the Flashduty OpenAPI schema.

type EnrichFilter 

type EnrichFilter struct {
	// Event key to match on (e.g. `labels.severity`, `title`). Must be non-empty.
	Key string `json:"key" toon:"key"`
	// Match operator. `IN` matches when any value matches; `NOTIN` matches when none of the values match.
	Oper string `json:"oper" toon:"oper"`
	// Values to match against. Must contain at least one value.
	Vals []string `json:"vals" toon:"vals"`
}

EnrichFilter is generated from the Flashduty OpenAPI schema.

type EnrichRule 

type EnrichRule struct {
	// Optional AND-filter list; the rule is skipped unless every filter matches. `null` when the rule has no condition. Filter keys come from the alert/change event vocabulary (e.g. `title`, `labels.severity`).
	If []EnrichFilter `json:"if,omitempty" toon:"if,omitempty"`
	// Rule type.
	// | Value | Meaning |
	// |---|---|
	// | `extraction` | Extract a value from the alert's `title`, `description`, or a `labels.*` key via regex or GJson, and write it to a label. |
	// | `composition` | Render a Go `text/template` against the event and write the result to a label. |
	// | `mapping` | Look up labels from a mapping schema or an external mapping API. |
	// | `drop` | Remove the listed labels from the alert. |
	Kind string `json:"kind" toon:"kind"`
	// Rule-kind–specific settings. The shape depends on `kind`.
	Settings any `json:"settings" toon:"settings"`
}

EnrichRule is generated from the Flashduty OpenAPI schema.

type EnrichmentInfoRequest 

type EnrichmentInfoRequest struct {
	// Integration ID to query enrichment rules for. Must be greater than 0.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
}

EnrichmentInfoRequest is generated from the Flashduty OpenAPI schema.

type EnrichmentItem 

type EnrichmentItem struct {
	// Creation timestamp, Unix seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Creator member ID.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Deletion time, Unix seconds. Omitted when the rule set is not deleted; read endpoints never return soft-deleted rule sets, so this is effectively always omitted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Integration ID.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Ordered enrichment rules.
	Rules []EnrichRule `json:"rules" toon:"rules"`
	// Rule set status: `enabled` (active) or `deleted` (soft-deleted). Read endpoints exclude soft-deleted rule sets, so responses always carry `enabled`.
	Status string `json:"status" toon:"status"`
	// Last update timestamp, Unix seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Last updater member ID.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

EnrichmentItem is generated from the Flashduty OpenAPI schema.

type EnrichmentListRequest 

type EnrichmentListRequest struct {
	// List of integration IDs to query. Must contain at least one ID.
	IntegrationIDs []int64 `json:"integration_ids" toon:"integration_ids"`
}

EnrichmentListRequest is generated from the Flashduty OpenAPI schema.

type EnrichmentListResponse 

type EnrichmentListResponse struct {
	// Enrichment rule sets.
	Items []EnrichmentItem `json:"items" toon:"items"`
}

EnrichmentListResponse is generated from the Flashduty OpenAPI schema.

type EnrichmentUpsertRequest 

type EnrichmentUpsertRequest struct {
	// Integration ID to configure enrichment rules for.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Ordered list of enrichment rules. Replaces all existing rules.
	Rules []EnrichRule `json:"rules" toon:"rules"`
}

EnrichmentUpsertRequest is generated from the Flashduty OpenAPI schema.

type EnvironmentBinding added in v0.5.4 

type EnvironmentBinding struct {
	// Environment identifier: a cloud sandbox ID for `cloud` bindings, a runner/environment ID for `byoc` bindings.
	ID string `json:"id" toon:"id"`
	// Environment kind bound to the session: `cloud` (managed sandbox) or `byoc` (self-hosted runner).
	Kind string `json:"kind" toon:"kind"`
	// Human-readable environment name; empty for cloud bindings using the default allowlist.
	Name string `json:"name" toon:"name"`
	// Live binding health, namespaced by kind: BYOC uses online/pending/offline/deleted; cloud uses available/rebuilding/expired.
	Status string `json:"status" toon:"status"`
}

EnvironmentBinding is generated from the Flashduty OpenAPI schema.

type ErrorCode 

type ErrorCode string

ErrorCode Flashduty error code enum. Every failed API response sets `error.code` to one of these stable wire strings. HTTP status is informational — the authoritative signal is the enum value. 

const (
	ErrorCodeOK                    ErrorCode = "OK"
	ErrorCodeInvalidParameter      ErrorCode = "InvalidParameter"
	ErrorCodeBadRequest            ErrorCode = "BadRequest"
	ErrorCodeInvalidContentType    ErrorCode = "InvalidContentType"
	ErrorCodeResourceNotFound      ErrorCode = "ResourceNotFound"
	ErrorCodeNoLicense             ErrorCode = "NoLicense"
	ErrorCodeReferenceExist        ErrorCode = "ReferenceExist"
	ErrorCodeUnauthorized          ErrorCode = "Unauthorized"
	ErrorCodeBalanceNotEnough      ErrorCode = "BalanceNotEnough"
	ErrorCodeAccessDenied          ErrorCode = "AccessDenied"
	ErrorCodeRouteNotFound         ErrorCode = "RouteNotFound"
	ErrorCodeMethodNotAllowed      ErrorCode = "MethodNotAllowed"
	ErrorCodeUndonedOrderExist     ErrorCode = "UndonedOrderExist"
	ErrorCodeRequestLocked         ErrorCode = "RequestLocked"
	ErrorCodeEntityTooLarge        ErrorCode = "EntityTooLarge"
	ErrorCodeRequestTooFrequently  ErrorCode = "RequestTooFrequently"
	ErrorCodeRequestVerifyRequired ErrorCode = "RequestVerifyRequired"
	ErrorCodeDangerousOperation    ErrorCode = "DangerousOperation"
	ErrorCodeInternalError         ErrorCode = "InternalError"
	ErrorCodeServiceUnavailable    ErrorCode = "ServiceUnavailable"
)

func ErrorCodeOf 

func ErrorCodeOf(err error) ErrorCode

ErrorCodeOf extracts the API ErrorCode carried by err, if any.

It searches the error chain with errors.As for an *ErrorResponse and returns ErrorCode(apiErr.Code). Because *RateLimitError unwraps to *ErrorResponse, this also resolves the code for rate-limit errors. If no *ErrorResponse is present in the chain, it returns the empty ErrorCode ("").

func (ErrorCode) String added in v0.5.2 

func (e ErrorCode) String() string

String returns the underlying string value, implementing fmt.Stringer.

type ErrorIngestionRulesService added in v0.10.0 

type ErrorIngestionRulesService service

ErrorIngestionRulesService handles the "RUM/Error ingestion rules" API resource.

func (*ErrorIngestionRulesService) Create added in v0.10.0 

func (s *ErrorIngestionRulesService) Create(ctx context.Context, req *RUMErrorIngestionCreateRequest) (*RUMErrorIngestionCreateResponse, *Response, error)

Create an error ingestion rule.

Create a new error ingestion rule that filters which errors are stored.

API: POST /rum/error-ingestion/rules/create (rum-error-ingestion-rules-create).

func (*ErrorIngestionRulesService) Delete added in v0.10.0 

func (s *ErrorIngestionRulesService) Delete(ctx context.Context, req *RUMErrorIngestionRuleIDRequest) (*Response, error)

Delete an error ingestion rule.

Delete an error ingestion rule from a RUM application.

API: POST /rum/error-ingestion/rules/delete (rum-error-ingestion-rules-delete).

func (*ErrorIngestionRulesService) Disable added in v0.10.0 

func (s *ErrorIngestionRulesService) Disable(ctx context.Context, req *RUMErrorIngestionRuleIDRequest) (*Response, error)

Disable an error ingestion rule.

Disable an error ingestion rule without deleting it.

API: POST /rum/error-ingestion/rules/disable (rum-error-ingestion-rules-disable).

func (*ErrorIngestionRulesService) Enable added in v0.10.0 

func (s *ErrorIngestionRulesService) Enable(ctx context.Context, req *RUMErrorIngestionRuleIDRequest) (*Response, error)

Enable an error ingestion rule.

Re-enable a previously disabled error ingestion rule.

API: POST /rum/error-ingestion/rules/enable (rum-error-ingestion-rules-enable).

func (*ErrorIngestionRulesService) HistoryList added in v0.10.0 

func (s *ErrorIngestionRulesService) HistoryList(ctx context.Context, req *RUMErrorIngestionHistoryListRequest) (*RUMErrorIngestionHistoryListResponse, *Response, error)

List error ingestion rule history.

Return paginated snapshots of an application's error ingestion rule history.

API: POST /rum/error-ingestion/rules/history/list (rum-error-ingestion-rules-history-list).

func (*ErrorIngestionRulesService) HistoryRevert added in v0.10.0 

func (s *ErrorIngestionRulesService) HistoryRevert(ctx context.Context, req *RUMErrorIngestionRevertRequest) (*Response, error)

Revert error ingestion rules to a history version.

Restore an application's entire rule set to a prior history version.

API: POST /rum/error-ingestion/rules/history/revert (rum-error-ingestion-rules-history-revert).

func (*ErrorIngestionRulesService) List added in v0.10.0 

func (s *ErrorIngestionRulesService) List(ctx context.Context, req *RUMErrorIngestionListRequest) (*RUMErrorIngestionListResponse, *Response, error)

List error ingestion rules.

Return every error ingestion rule configured for a RUM application.

API: POST /rum/error-ingestion/rules/list (rum-error-ingestion-rules-list).

func (*ErrorIngestionRulesService) Update added in v0.10.0 

func (s *ErrorIngestionRulesService) Update(ctx context.Context, req *RUMErrorIngestionUpdateRequest) (*Response, error)

Update an error ingestion rule.

Update the name, description, or filters of an error ingestion rule.

API: POST /rum/error-ingestion/rules/update (rum-error-ingestion-rules-update).

type ErrorResponse 

type ErrorResponse struct {
	Response  *http.Response `json:"-"`
	Code      string         `json:"code"`
	Reason    string         `json:"reason,omitempty"`
	Message   string         `json:"message"`
	RequestID string         `json:"request_id"`
}

ErrorResponse is returned by any Flashduty API call that does not succeed — either the envelope carried an error or the HTTP status was non-2xx. Recover it with errors.As to inspect Code (see the generated ErrorCode constants) and RequestID.

func (*ErrorResponse) Error 

func (e *ErrorResponse) Error() string

type ErsComposition 

type ErsComposition struct {
	// When `true`, overwrite the label if it already exists. Defaults to `false`.
	Override bool `json:"override,omitempty" toon:"override,omitempty"`
	// Destination label key the composed value is written to. Must match `^[a-zA-Z_][a-zA-Z0-9_]*$`.
	ResultLabel string `json:"result_label" toon:"result_label"`
	// Go `text/template` string (1–500 characters) rendered against the event struct — e.g. `{{.Title}}`, `{{.Description}}`, `{{.Labels.key}}`. Example: `{{.Labels.region}}-{{.Labels.env}}`.
	Template string `json:"template" toon:"template"`
}

ErsComposition is generated from the Flashduty OpenAPI schema.

type ErsDrop 

type ErsDrop struct {
	// List of label keys to remove from the alert.
	DropLabels []string `json:"drop_labels" toon:"drop_labels"`
}

ErsDrop is generated from the Flashduty OpenAPI schema.

type ErsExtraction 

type ErsExtraction struct {
	// GJson path expression used to extract a value from a JSON-encoded field. Mutually exclusive with `pattern`.
	GJSON string `json:"g_json,omitempty" toon:"g_json,omitempty"`
	// When `true`, overwrite the label if it already exists. Defaults to `false`.
	Override bool `json:"override,omitempty" toon:"override,omitempty"`
	// RE2 regular expression applied to the source value. Must contain at least one capture group; the captured groups are joined with a space and written to `result_label`. Mutually exclusive with `g_json`.
	Pattern string `json:"pattern,omitempty" toon:"pattern,omitempty"`
	// Destination label key the extracted value is written to. Must match `^[a-zA-Z_][a-zA-Z0-9_]*$`.
	ResultLabel string `json:"result_label" toon:"result_label"`
	// Source field to extract from. Must be `title`, `description`, or a label key prefixed with `labels.` (e.g. `labels.env`).
	SourceField string `json:"source_field" toon:"source_field"`
}

ErsExtraction is generated from the Flashduty OpenAPI schema.

type ErsMapping 

type ErsMapping struct {
	// Mapping API ID (MongoDB ObjectID hex). Required when `mapping_type` is `api`.
	APIID string `json:"api_id,omitempty" toon:"api_id,omitempty"`
	// Mapping source type. `schema` uses a mapping schema table; `api` calls an external HTTP API.
	MappingType string `json:"mapping_type,omitempty" toon:"mapping_type,omitempty"`
	// When `true`, overwrite labels that already exist. Defaults to `false`.
	Override bool `json:"override,omitempty" toon:"override,omitempty"`
	// Label keys to populate from the mapping lookup result. Each must match `^[a-zA-Z_][a-zA-Z0-9_]*$`.
	ResultLabels []string `json:"result_labels" toon:"result_labels"`
	// Mapping schema ID (MongoDB ObjectID hex). Required when `mapping_type` is `schema`.
	SchemaID string `json:"schema_id,omitempty" toon:"schema_id,omitempty"`
}

ErsMapping is generated from the Flashduty OpenAPI schema.

type EscalateLayer 

type EscalateLayer struct {
	// Wait before moving to the next level, in minutes.
	EscalateWindow int64 `json:"escalate_window,omitempty" toon:"escalate_window,omitempty"`
	// When true, always escalate regardless of acknowledgement.
	ForceEscalate bool `json:"force_escalate,omitempty" toon:"force_escalate,omitempty"`
	// Max repeat notifications within the level.
	MaxTimes int64 `json:"max_times,omitempty" toon:"max_times,omitempty"`
	// Repeat interval in minutes.
	NotifyStep float64        `json:"notify_step,omitempty" toon:"notify_step,omitempty"`
	Target     EscalateTarget `json:"target" toon:"target"`
}

EscalateLayer is generated from the Flashduty OpenAPI schema.

type EscalateRuleItem 

type EscalateRuleItem struct {
	// Owning account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Delay window in seconds.
	AggrWindow int64 `json:"aggr_window" toon:"aggr_window"`
	// Channel the rule belongs to.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel name, populated for cross-channel listing responses.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Creation time, Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Deletion time, Unix timestamp in seconds. Omitted unless the rule is soft-deleted; deleted rules are excluded from list responses.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Rule description.
	Description string `json:"description" toon:"description"`
	// Incident-level match conditions (OR-of-AND tree): the rule is matched against the incident the alert was grouped into, not against the alert itself. Omit or leave empty to apply the rule to all incidents in the channel.
	Filters FilterGroup `json:"filters" toon:"filters"`
	// Escalation levels in order.
	Layers []EscalateLayer `json:"layers" toon:"layers"`
	// Evaluation priority. Lower runs first.
	Priority int64 `json:"priority" toon:"priority"`
	// Escalation rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Rule status: `enabled` means active, `disabled` means paused, `deleted` is soft-deleted (possible only from the detail endpoint; lists never return deleted rules).
	Status string `json:"status" toon:"status"`
	// Notification template ID (MongoDB ObjectID).
	TemplateID string `json:"template_id" toon:"template_id"`
	// Recurring time windows during which the rule applies.
	TimeFilters []TimeFilter `json:"time_filters" toon:"time_filters"`
	// Last update time, Unix timestamp in seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Member ID that last updated the rule.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

EscalateRuleItem is generated from the Flashduty OpenAPI schema.

type EscalateTarget 

type EscalateTarget struct {
	// Per-severity personal notification channels. Required unless `webhooks` is provided.
	By EscalateTargetBy `json:"by,omitzero" toon:"by,omitempty"`
	// Email addresses to notify (push-only scenarios).
	Emails []string `json:"emails,omitempty" toon:"emails,omitempty"`
	// Member IDs to notify directly.
	PersonIDs []int64 `json:"person_ids,omitempty" toon:"person_ids,omitempty"`
	// Map of schedule ID to the role IDs on that schedule to notify.
	ScheduleToRoleIDs map[string][]int64 `json:"schedule_to_role_ids,omitempty" toon:"schedule_to_role_ids,omitempty"`
	// Team IDs to notify.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
	// Group chat / webhook targets. Required unless `by` is provided.
	Webhooks []EscalateTargetWebhooksItem `json:"webhooks,omitempty" toon:"webhooks,omitempty"`
}

EscalateTarget is generated from the Flashduty OpenAPI schema.

type EscalateTargetBy 

type EscalateTargetBy struct {
	// Notify channels used for Critical severity. Personal channels: `sms`, `voice`, `email`, `push`; IM group-chat channels: `feishu_app:<chat_id>`, `dingtalk_app:<chat_id>`, `wecom_app:<chat_id>`, `slack_app:<chat_id>`, `teams_app:<chat_id>`.
	Critical []string `json:"critical,omitempty" toon:"critical,omitempty"`
	// When true, use each responder's personal preference instead of the lists below.
	FollowPreference bool `json:"follow_preference,omitempty" toon:"follow_preference,omitempty"`
	// Notify channels used for Info severity. Values as for `critical`.
	Info []string `json:"info,omitempty" toon:"info,omitempty"`
	// Notify channels used for Warning severity. Values as for `critical`.
	Warning []string `json:"warning,omitempty" toon:"warning,omitempty"`
}

EscalateTargetBy is generated from the Flashduty OpenAPI schema.

type EscalateTargetWebhooksItem 

type EscalateTargetWebhooksItem struct {
	// Type-specific settings (chat IDs, URLs, etc.).
	Settings map[string]any `json:"settings" toon:"settings"`
	// Webhook type, one of `feishu`, `feishu_app`, `dingtalk`, `dingtalk_app`, `wecom`, `slack`, `slack_app`, `teams_app`, `telegram`, `zoom`.
	Type string `json:"type" toon:"type"`
}

EscalateTargetWebhooksItem is generated from the Flashduty OpenAPI schema.

type EventGroup added in v0.14.3 

type EventGroup struct {
	// When true, repeated events merge into the existing alert; when false, every event creates a separate alert. Defaults to true.
	IsEnabled bool `json:"is_enabled,omitempty" toon:"is_enabled,omitempty"`
	// Merge window in minutes, 1-1440 (24 h); accounts with the extended limit may use up to 10080 (7 days). Defaults to 1440.
	TimeWindow int64 `json:"time_window,omitempty" toon:"time_window,omitempty"`
}

EventGroup is generated from the Flashduty OpenAPI schema.

type EventItem added in v0.5.4 

type EventItem struct {
	// ADK actions envelope (state deltas, transfers, escalation).
	Actions map[string]any `json:"actions" toon:"actions"`
	// Event author (e.g. user, the agent name).
	Author string `json:"author" toon:"author"`
	// ADK branch path for nested agents.
	Branch string `json:"branch" toon:"branch"`
	// ADK content envelope {role, parts:[...]}.
	Content map[string]any `json:"content" toon:"content"`
	// Unix timestamp in milliseconds when the event was written.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Error code when the event represents a failure.
	ErrorCode string `json:"error_code" toon:"error_code"`
	// Human-readable error message, when present.
	ErrorMessage string `json:"error_message" toon:"error_message"`
	// Event identifier.
	EventID string `json:"event_id" toon:"event_id"`
	// ADK invocation id grouping a turn.
	InvocationID string `json:"invocation_id" toon:"invocation_id"`
	// True for a streaming partial chunk.
	Partial bool `json:"partial" toon:"partial"`
	// Owning session id.
	SessionID string `json:"session_id" toon:"session_id"`
	// Event status. One of: `normal` (a live event included in the context fed to the model), `compressed` (folded into a compaction summary boundary event; no longer loaded for the model, kept as history only).
	Status string `json:"status" toon:"status"`
	// True on the terminal event of a turn.
	TurnComplete bool `json:"turn_complete" toon:"turn_complete"`
	// Per-turn token usage metadata.
	UsageMetadata map[string]any `json:"usage_metadata" toon:"usage_metadata"`
}

EventItem is generated from the Flashduty OpenAPI schema.

type ExportLine added in v0.5.4 

type ExportLine struct {
	// Account id (on session_meta).
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Dispatched subagent name (on subagent_dispatch).
	AgentName string `json:"agent_name" toon:"agent_name"`
	// Agent app (on session_meta).
	AppName string `json:"app_name" toon:"app_name"`
	// Child session id created by the dispatch (on subagent_dispatch).
	ChildSessionID string `json:"child_session_id" toon:"child_session_id"`
	// Text content of the line (messages, answers, errors).
	Content string `json:"content" toon:"content"`
	// Call duration in milliseconds.
	DurationMs int64 `json:"duration_ms" toon:"duration_ms"`
	// RFC3339 end timestamp; stamped on llm_call/tool_call/session_meta.
	EndedAt string `json:"ended_at" toon:"ended_at"`
	// Error detail when a call failed.
	Error string `json:"error" toon:"error"`
	// Tool call input arguments (on tool_call).
	Input map[string]any `json:"input" toon:"input"`
	// Byte size of the tool input.
	InputBytes int64 `json:"input_bytes" toon:"input_bytes"`
	// Chat model provider key; on session_meta and llm_call.
	Model string `json:"model" toon:"model"`
	// Tool name (on tool_call).
	Name string `json:"name" toon:"name"`
	// Tool call output (on tool_call response side).
	Output string `json:"output" toon:"output"`
	// Byte size of the tool output.
	OutputBytes int64 `json:"output_bytes" toon:"output_bytes"`
	// Parent session id for child sessions (on session_meta).
	ParentSessionID string `json:"parent_session_id" toon:"parent_session_id"`
	// 1-based monotonic sequence within the session (absent on session_meta).
	Seq int64 `json:"seq" toon:"seq"`
	// Session id (on session_meta).
	SessionID string `json:"session_id" toon:"session_id"`
	// RFC3339 start timestamp (session_meta uses session.created_at).
	StartedAt string `json:"started_at" toon:"started_at"`
	// Tool result status, e.g. ok or error.
	Status string `json:"status" toon:"status"`
	// RFC3339 timestamp of the event.
	TS string `json:"ts" toon:"ts"`
	// Line discriminator.
	Type  string      `json:"type" toon:"type"`
	Usage ExportUsage `json:"usage" toon:"usage"`
}

ExportLine is one decoded line of a session export stream. The Type field discriminates the event kind (session_meta, user_message, llm_call, tool_call, subagent_dispatch, final_answer, agent_text, error); the remaining fields are populated per kind. It is hand-maintained here, alongside the hand-written streaming Export endpoint, because the typed generator only models JSON-envelope responses and excludes the NDJSON export stream (so its line schema is pruned as unreferenced).

func DecodeExportLine added in v0.5.4 

func DecodeExportLine(line []byte) (*ExportLine, error)

DecodeExportLine unmarshals one raw NDJSON export line into an ExportLine. Use the Type field to discriminate (session_meta, user_message, llm_call, tool_call, subagent_dispatch, final_answer, agent_text, error).

type ExportStatusPageSubscribersRequest 

type ExportStatusPageSubscribersRequest struct {
	// Optional component IDs to filter subscribers by.
	ComponentIDs []string `json:"component_ids,omitempty" toon:"component_ids,omitempty"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
}

ExportStatusPageSubscribersRequest is generated from the Flashduty OpenAPI schema.

type ExportUsage added in v0.5.4 

type ExportUsage struct {
	// Tokens written to the prompt cache.
	CacheCreation int64 `json:"cache_creation" toon:"cache_creation"`
	// Tokens served from the prompt cache.
	CacheRead int64 `json:"cache_read" toon:"cache_read"`
	// Prompt (input) tokens for the call.
	InputTokens int64 `json:"input_tokens" toon:"input_tokens"`
	// Generated (output) tokens for the call.
	OutputTokens int64 `json:"output_tokens" toon:"output_tokens"`
}

ExportUsage is the token-usage sub-object on an ExportLine (llm_call events).

type ExportedStatusPageSubscriberItem 

type ExportedStatusPageSubscriberItem struct {
	// Whether the subscriber is subscribed to all components.
	All bool `json:"all" toon:"all"`
	// Components this subscriber has subscribed to.
	Components []StatusPageComponentItem `json:"components" toon:"components"`
	// Preferred locale for notifications. Omitted when empty.
	Locale string `json:"locale" toon:"locale"`
	// Subscription notification method. `email` is email subscription (public pages); `im` is IM subscription (internal pages). Determined by the page type.
	Method string `json:"method" toon:"method"`
	// Subscriber recipient: email address for public pages, user ID for internal pages.
	Recipient string `json:"recipient" toon:"recipient"`
}

ExportedStatusPageSubscriberItem is generated from the Flashduty OpenAPI schema.

type FacetCountItem added in v0.5.4 

type FacetCountItem struct {
	// Number of events with this facet value in the time range.
	Count int64 `json:"count" toon:"count"`
	// The facet value. Type matches the field's `value_type`.
	FacetValue any `json:"facet_value" toon:"facet_value"`
}

FacetCountItem is generated from the Flashduty OpenAPI schema.

type FacetsService added in v0.5.4 

type FacetsService service

FacetsService handles the "RUM/Facets" API resource.

func (*FacetsService) FacetCount added in v0.5.4 

func (s *FacetsService) FacetCount(ctx context.Context, req *RUMFacetCountRequest) (*RUMFacetCountResponse, *Response, error)

Count facet value distribution.

Return the top N values for a facet field within a time range, sorted by occurrence count descending.

API: POST /rum/facet/count (rum-read-facet-count).

func (*FacetsService) FieldList added in v0.5.4 

func (s *FacetsService) FieldList(ctx context.Context, req *RUMFieldListRequest) (*RUMFieldListResponse, *Response, error)

List RUM fields.

Return RUM field definitions, optionally filtered by scope and facet status.

API: POST /rum/field/list (rum-read-field-list).

type FeedDetailAlertAck added in v0.14.3 

type FeedDetailAlertAck struct{}

FeedDetailAlertAck is generated from the Flashduty OpenAPI schema.

type FeedDetailAlertClose 

type FeedDetailAlertClose struct{}

FeedDetailAlertClose is generated from the Flashduty OpenAPI schema.

type FeedDetailAlertComment 

type FeedDetailAlertComment struct {
	// Comment body.
	Comment string `json:"comment" toon:"comment"`
}

FeedDetailAlertComment is generated from the Flashduty OpenAPI schema.

type FeedDetailAlertMerge added in v0.14.3 

type FeedDetailAlertMerge struct {
	// Comment recorded with the merge. Omitted when empty.
	Comment string `json:"comment" toon:"comment"`
	// New owner member ID set on the target incident. Omitted when unchanged.
	OwnerID int64 `json:"owner_id" toon:"owner_id"`
	// Source alerts merged into the target incident. Omitted when empty.
	SourceAlerts []AlertShort `json:"source_alerts" toon:"source_alerts"`
	// Incident the alerts were merged into. Omitted when not recorded.
	TargetIncident IncidentShort `json:"target_incident" toon:"target_incident"`
	// New title set on the target incident. Omitted when unchanged.
	Title string `json:"title" toon:"title"`
}

FeedDetailAlertMerge is generated from the Flashduty OpenAPI schema.

type FeedDetailAlertMuteByFlapping added in v0.14.3 

type FeedDetailAlertMuteByFlapping struct {
	// Window in seconds over which the state changes were counted. Omitted when zero.
	InSecs int64 `json:"in_secs" toon:"in_secs"`
	// State-change count threshold that triggered flapping detection. Omitted when zero.
	MaxChanges int64 `json:"max_changes" toon:"max_changes"`
	// Mute duration in seconds. Omitted when zero.
	MuteSecs int64 `json:"mute_secs" toon:"mute_secs"`
}

FeedDetailAlertMuteByFlapping is generated from the Flashduty OpenAPI schema.

type FeedDetailAlertMuteByInhibit added in v0.14.3 

type FeedDetailAlertMuteByInhibit struct {
	// Inhibit rule ID that muted the alert. Omitted when empty.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Inhibit rule name, resolved at read time. Omitted when empty.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// ID of the source alert that triggered the inhibition. Omitted when empty.
	SourceAlertID string `json:"source_alert_id" toon:"source_alert_id"`
	// Title of the source alert, resolved at read time. Omitted when empty.
	SourceAlertTitle string `json:"source_alert_title" toon:"source_alert_title"`
}

FeedDetailAlertMuteByInhibit is generated from the Flashduty OpenAPI schema.

type FeedDetailAlertMuteBySilence added in v0.14.3 

type FeedDetailAlertMuteBySilence struct {
	// Silence rule ID that muted the alert. Omitted when empty.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Silence rule name, resolved at read time. Omitted when empty.
	RuleName string `json:"rule_name" toon:"rule_name"`
}

FeedDetailAlertMuteBySilence is generated from the Flashduty OpenAPI schema.

type FeedDetailAlertTrigger 

type FeedDetailAlertTrigger struct {
	Severity FeedSeverity `json:"severity" toon:"severity"`
	Status   FeedSeverity `json:"status" toon:"status"`
}

FeedDetailAlertTrigger is generated from the Flashduty OpenAPI schema.

type FeedDetailAlertUnack added in v0.14.3 

type FeedDetailAlertUnack struct{}

FeedDetailAlertUnack is generated from the Flashduty OpenAPI schema.

type FeedDetailAlertUpdate added in v0.14.3 

type FeedDetailAlertUpdate struct {
	Severity FeedSeverity `json:"severity" toon:"severity"`
	Status   FeedSeverity `json:"status" toon:"status"`
}

FeedDetailAlertUpdate is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentAck 

type FeedDetailIncidentAck struct {
	// Form summary recorded as a timeline comment. Omitted when no acknowledgement form summary was submitted.
	Comment string `json:"comment" toon:"comment"`
	// Images from the acknowledgement form, recorded on the timeline entry only. Omitted when none were submitted.
	Images []Image `json:"images" toon:"images"`
	// Progress note entered at acknowledgement.
	Progress string `json:"progress" toon:"progress"`
}

FeedDetailIncidentAck is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentAddRspd 

type FeedDetailIncidentAddRspd struct {
	// Member IDs added as responders.
	To []int64 `json:"to" toon:"to"`
}

FeedDetailIncidentAddRspd is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentAssign 

type FeedDetailIncidentAssign struct {
	// Unix timestamp (seconds) when the assignment was made.
	AssignedAt Timestamp `json:"assigned_at" toon:"assigned_at"`
	// Email recipients, used by integrations such as ServiceNow.
	Emails []string `json:"emails" toon:"emails"`
	// Escalation rule ID (MongoDB ObjectID) to drive assignment.
	EscalateRuleID string `json:"escalate_rule_id" toon:"escalate_rule_id"`
	// Escalation rule display name, filled by the server.
	EscalateRuleName string `json:"escalate_rule_name" toon:"escalate_rule_name"`
	// Opaque assignment ID generated by the server.
	ID string `json:"id" toon:"id"`
	// Current level index within the escalation rule.
	LayerIdx int64 `json:"layer_idx" toon:"layer_idx"`
	// Override the notification channels used for this assignment.
	Notify FeedDetailIncidentAssignNotify `json:"notify" toon:"notify"`
	// Member IDs to assign directly.
	PersonIDs []int64 `json:"person_ids" toon:"person_ids"`
	// Member IDs that received the assignment.
	To []int64 `json:"to" toon:"to"`
	// Assignment type: `assign` direct assignment, `reassign` reassignment, `escalate` escalation-rule driven, `reopen` automatic reassignment on reopen.
	Type string `json:"type" toon:"type"`
}

FeedDetailIncidentAssign is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentAssignNotify added in v0.12.1 

type FeedDetailIncidentAssignNotify struct {
	// When false, use `personal_channels`; when true or omitted, use each responder's personal preference.
	FollowPreference bool `json:"follow_preference" toon:"follow_preference"`
	// Channels to use (e.g. `voice`, `sms`, `email`).
	PersonalChannels []string `json:"personal_channels" toon:"personal_channels"`
	// Notification template ID (MongoDB ObjectID).
	TemplateID string `json:"template_id" toon:"template_id"`
}

FeedDetailIncidentAssignNotify is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentAutoRefreshCard 

type FeedDetailIncidentAutoRefreshCard struct{}

FeedDetailIncidentAutoRefreshCard is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentComment 

type FeedDetailIncidentComment struct {
	// Comment body.
	Comment     string                     `json:"comment" toon:"comment"`
	CommentType IncidentCommentTypeDisplay `json:"comment_type" toon:"comment_type"`
	// ObjectID of the account-level comment type attached to the comment.
	CommentTypeID string `json:"comment_type_id" toon:"comment_type_id"`
	// Whether replies to this comment are muted.
	MuteReply bool `json:"mute_reply" toon:"mute_reply"`
}

FeedDetailIncidentComment is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentCustomAction 

type FeedDetailIncidentCustomAction struct {
	// Integration ID that executed the action.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Integration display name.
	IntegrationName string `json:"integration_name" toon:"integration_name"`
}

FeedDetailIncidentCustomAction is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentMerge 

type FeedDetailIncidentMerge struct {
	// Merge comment.
	Comment string `json:"comment" toon:"comment"`
	// Member ID that performed the merge.
	OwnerID int64 `json:"owner_id" toon:"owner_id"`
	// True if the source incidents were removed after merging.
	RemoveSourceIncidents bool `json:"remove_source_incidents" toon:"remove_source_incidents"`
	// Source incidents that were merged.
	SourceIncidents []IncidentShort `json:"source_incidents" toon:"source_incidents"`
	// Responder member IDs carried over from the source incidents.
	SourceResponders []int64       `json:"source_responders" toon:"source_responders"`
	TargetIncident   IncidentShort `json:"target_incident" toon:"target_incident"`
	// Resulting incident title.
	Title string `json:"title" toon:"title"`
}

FeedDetailIncidentMerge is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentMuteByFlapping 

type FeedDetailIncidentMuteByFlapping struct {
	// Window length in minutes.
	InMins int64 `json:"in_mins" toon:"in_mins"`
	// Maximum state changes allowed within the window.
	MaxChanges int64 `json:"max_changes" toon:"max_changes"`
	// Mute duration in minutes once flapping is detected.
	MuteMins int64 `json:"mute_mins" toon:"mute_mins"`
}

FeedDetailIncidentMuteByFlapping is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentMuteReply 

type FeedDetailIncidentMuteReply struct{}

FeedDetailIncidentMuteReply is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentNew 

type FeedDetailIncidentNew struct {
	// Email of the reporter when the incident was created externally.
	ReporterEmail string       `json:"reporter_email" toon:"reporter_email"`
	Severity      FeedSeverity `json:"severity" toon:"severity"`
	// Initial incident title.
	Title string `json:"title" toon:"title"`
}

FeedDetailIncidentNew is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentNotify 

type FeedDetailIncidentNotify struct {
	// Delivery channel or method label.
	By string `json:"by" toon:"by"`
	// Per-chat delivery records.
	Chats []NotifyChat `json:"chats" toon:"chats"`
	// Escalation rule ID (MongoDB ObjectID).
	EscalateRuleID string `json:"escalate_rule_id" toon:"escalate_rule_id"`
	// Escalation rule display name.
	EscalateRuleName string `json:"escalate_rule_name" toon:"escalate_rule_name"`
	// Whether this is the first fire or a refire. `fire`: the first notification for this escalation layer; `refire`: a repeat notification to the same layer when the incident remains unhandled, sent at the layer's notify interval and capped by the layer's maximum refire count.
	FireType string `json:"fire_type" toon:"fire_type"`
	// Escalation level index used for this notification.
	LayerIdx int64 `json:"layer_idx" toon:"layer_idx"`
	// Upstream message ID returned by the delivery channel.
	MsgID string `json:"msg_id" toon:"msg_id"`
	// Per-person delivery records.
	Persons []NotifyPerson `json:"persons" toon:"persons"`
	// Notification record ID.
	Rid string `json:"rid" toon:"rid"`
	// Per-robot delivery records.
	Robots []NotifyRobot `json:"robots" toon:"robots"`
}

FeedDetailIncidentNotify is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentReopen 

type FeedDetailIncidentReopen struct {
	// Reason why the incident was reopened.
	Reason string `json:"reason" toon:"reason"`
}

FeedDetailIncidentReopen is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentResetDescription 

type FeedDetailIncidentResetDescription struct{}

FeedDetailIncidentResetDescription is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentResetField 

type FeedDetailIncidentResetField struct {
	// Name of the custom field that was updated.
	FieldName string `json:"field_name" toon:"field_name"`
	// New value of the custom field. Type depends on the field definition.
	To any `json:"to" toon:"to"`
}

FeedDetailIncidentResetField is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentResetImpact 

type FeedDetailIncidentResetImpact struct{}

FeedDetailIncidentResetImpact is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentResetResolution 

type FeedDetailIncidentResetResolution struct{}

FeedDetailIncidentResetResolution is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentResetRootCause 

type FeedDetailIncidentResetRootCause struct{}

FeedDetailIncidentResetRootCause is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentResetSeverity 

type FeedDetailIncidentResetSeverity struct {
	From FeedSeverity `json:"from" toon:"from"`
	To   FeedSeverity `json:"to" toon:"to"`
}

FeedDetailIncidentResetSeverity is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentResetTitle 

type FeedDetailIncidentResetTitle struct {
	// Previous title.
	From string `json:"from" toon:"from"`
	// New title.
	To string `json:"to" toon:"to"`
}

FeedDetailIncidentResetTitle is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentResolve 

type FeedDetailIncidentResolve struct {
	// Form summary recorded as a timeline comment on resolution. Omitted when no resolve form summary was submitted.
	Comment string `json:"comment" toon:"comment"`
	// Source that triggered the resolve.
	// | Value | Meaning |
	// |---|---|
	// | `voice` | Phone-call (voice DTMF) action. |
	// | `console` | Console (Web UI) action. |
	// | `card` | IM notification card button (DingTalk/Feishu/Slack/Teams). |
	// | `wcard` | WeCom notification card button. |
	// | `event` | Event-driven: auto-close when all related alerts recover to Ok, or a close synced from an external ITSM system. |
	// | `autorslv` | Auto-resolve: closed by the system after no new alerts within the channel's auto-resolve timeout. |
	// | `autorefresh` | Card auto-refresh (reserved; never appears on resolve feeds). |
	// | `escalation` | Escalation flow (reserved; never appears on resolve feeds). |
	From string `json:"from" toon:"from"`
	// Images from the resolve form, recorded on the timeline entry only. Omitted when none were submitted.
	Images []Image `json:"images" toon:"images"`
}

FeedDetailIncidentResolve is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentSnooze 

type FeedDetailIncidentSnooze struct {
	// Snooze duration in minutes.
	Minutes int64 `json:"minutes" toon:"minutes"`
}

FeedDetailIncidentSnooze is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentStorm 

type FeedDetailIncidentStorm struct {
	// Storm threshold that was reached.
	Threshold int64 `json:"threshold" toon:"threshold"`
}

FeedDetailIncidentStorm is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentUnack 

type FeedDetailIncidentUnack struct {
	// Progress note entered when acknowledgement was removed.
	Progress string `json:"progress" toon:"progress"`
}

FeedDetailIncidentUnack is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentWake 

type FeedDetailIncidentWake struct {
	// Unix timestamp at which the prior snooze was scheduled to end.
	SnoozedBefore Timestamp `json:"snoozedBefore" toon:"snoozedBefore"`
}

FeedDetailIncidentWake is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentWarRoomCreate 

type FeedDetailIncidentWarRoomCreate struct {
	// Chat group identifier.
	ChatID string `json:"chat_id" toon:"chat_id"`
	// Chat group display name.
	ChatName string `json:"chat_name" toon:"chat_name"`
	// Integration ID that hosts the war room chat group.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Integration display name.
	IntegrationName string `json:"integration_name" toon:"integration_name"`
	// Chat integration plugin type.
	PluginType string `json:"plugin_type" toon:"plugin_type"`
	// Shareable join link for the war room.
	ShareLink string `json:"share_link" toon:"share_link"`
}

FeedDetailIncidentWarRoomCreate is generated from the Flashduty OpenAPI schema.

type FeedDetailIncidentWarRoomDelete 

type FeedDetailIncidentWarRoomDelete struct {
	// Chat group identifier.
	ChatID string `json:"chat_id" toon:"chat_id"`
	// Chat group display name.
	ChatName string `json:"chat_name" toon:"chat_name"`
	// Integration ID that hosted the war room chat group.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Integration display name.
	IntegrationName string `json:"integration_name" toon:"integration_name"`
	// Chat integration plugin type.
	PluginType string `json:"plugin_type" toon:"plugin_type"`
}

FeedDetailIncidentWarRoomDelete is generated from the Flashduty OpenAPI schema.

type FeedDetailWorkItemAssigneesChanged added in v0.8.0 

type FeedDetailWorkItemAssigneesChanged struct {
	// Member IDs added as assignees.
	AddedAssigneeIDs []int64 `json:"added_assignee_ids" toon:"added_assignee_ids"`
	// Assignee member IDs after the change.
	AssigneeIDs []int64 `json:"assignee_ids" toon:"assignee_ids"`
	// Work item type. `action`: an action item anchored to the incident itself; `follow_up`: an improvement item anchored to a post-mortem.
	ItemType string `json:"item_type" toon:"item_type"`
	// Member IDs removed from assignees.
	RemovedAssigneeIDs []int64 `json:"removed_assignee_ids" toon:"removed_assignee_ids"`
	// Work item title.
	Title string `json:"title" toon:"title"`
	// Work item ID.
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

FeedDetailWorkItemAssigneesChanged is generated from the Flashduty OpenAPI schema.

type FeedDetailWorkItemBound added in v0.8.0 

type FeedDetailWorkItemBound struct {
	// Work item type. `action`: an action item anchored to the incident itself; `follow_up`: an improvement item anchored to a post-mortem.
	ItemType string `json:"item_type" toon:"item_type"`
	// ID of the post-mortem the work item is bound to.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Work item title.
	Title string `json:"title" toon:"title"`
	// Work item ID.
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

FeedDetailWorkItemBound is generated from the Flashduty OpenAPI schema.

type FeedDetailWorkItemCompleted added in v0.8.0 

type FeedDetailWorkItemCompleted struct {
	// Status label before completion.
	FromStatus string `json:"from_status" toon:"from_status"`
	// Work item type. `action`: an action item anchored to the incident itself; `follow_up`: an improvement item anchored to a post-mortem.
	ItemType string `json:"item_type" toon:"item_type"`
	// ID of the post-mortem the work item is bound to.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Work item title.
	Title string `json:"title" toon:"title"`
	// Status label after completion.
	ToStatus string `json:"to_status" toon:"to_status"`
	// Work item ID.
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

FeedDetailWorkItemCompleted is generated from the Flashduty OpenAPI schema.

type FeedDetailWorkItemConverted added in v0.8.0 

type FeedDetailWorkItemConverted struct {
	// Work item type before the conversion. `action`: an action item anchored to the incident itself; `follow_up`: an improvement item anchored to a post-mortem. Conversion currently only supports `action` → `follow_up`, so `from_type` is always `action` in this event.
	FromType string `json:"from_type" toon:"from_type"`
	// ID of the post-mortem the work item is bound to.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Work item status label after the conversion.
	Status string `json:"status" toon:"status"`
	// Work item title.
	Title string `json:"title" toon:"title"`
	// Work item type after the conversion. `action`: an action item anchored to the incident itself; `follow_up`: an improvement item anchored to a post-mortem. Conversion currently only supports `action` → `follow_up`, so `to_type` is always `follow_up` in this event, and a successful conversion immediately tries to bind the incident's post-mortem.
	ToType string `json:"to_type" toon:"to_type"`
	// Work item ID.
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

FeedDetailWorkItemConverted is generated from the Flashduty OpenAPI schema.

type FeedDetailWorkItemCreated added in v0.8.0 

type FeedDetailWorkItemCreated struct {
	// Assignee member IDs.
	AssigneeIDs []int64 `json:"assignee_ids" toon:"assignee_ids"`
	// Work item type. `action`: an action item anchored to the incident itself, convertible to `follow_up` later; `follow_up`: an improvement item anchored to a post-mortem, requiring the incident to be linked to that post-mortem at creation.
	ItemType string `json:"item_type" toon:"item_type"`
	// ID of the post-mortem the work item is bound to.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Work item status label (e.g. `open`, `done`).
	Status string `json:"status" toon:"status"`
	// Work item title.
	Title string `json:"title" toon:"title"`
	// Work item ID.
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

FeedDetailWorkItemCreated is generated from the Flashduty OpenAPI schema.

type FeedDetailWorkItemDeleted added in v0.8.0 

type FeedDetailWorkItemDeleted struct {
	// Work item type. `action`: an action item anchored to the incident itself; `follow_up`: an improvement item anchored to a post-mortem.
	ItemType string `json:"item_type" toon:"item_type"`
	// ID of the post-mortem the work item is bound to.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Work item title.
	Title string `json:"title" toon:"title"`
	// Work item ID.
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

FeedDetailWorkItemDeleted is generated from the Flashduty OpenAPI schema.

type FeedDetailWorkItemUpdated added in v0.8.0 

type FeedDetailWorkItemUpdated struct {
	// Description before the update.
	FromDescription string `json:"from_description" toon:"from_description"`
	// Priority label before the update.
	FromPriority string `json:"from_priority" toon:"from_priority"`
	// Status label before the update.
	FromStatus string `json:"from_status" toon:"from_status"`
	// Title before the update.
	FromTitle string `json:"from_title" toon:"from_title"`
	// Work item type. `action`: an action item anchored to the incident itself; `follow_up`: an improvement item anchored to a post-mortem.
	ItemType string `json:"item_type" toon:"item_type"`
	// Work item title.
	Title string `json:"title" toon:"title"`
	// Description after the update.
	ToDescription string `json:"to_description" toon:"to_description"`
	// Priority label after the update.
	ToPriority string `json:"to_priority" toon:"to_priority"`
	// Status label after the update.
	ToStatus string `json:"to_status" toon:"to_status"`
	// Work item ID.
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

FeedDetailWorkItemUpdated is generated from the Flashduty OpenAPI schema.

type FeedItem 

type FeedItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Creation timestamp in Unix epoch milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Member ID of the creator. 0 for system-generated entries.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Soft-delete time, Unix epoch milliseconds. Omitted when not deleted.
	DeletedAt TimestampMilli `json:"deleted_at" toon:"deleted_at"`
	// Type-specific payload; the concrete shape is determined by `type`. May be `null` for entries stored without detail.
	Detail any `json:"detail" toon:"detail"`
	// ObjectID of the alert this entry references.
	RefID string        `json:"ref_id" toon:"ref_id"`
	Type  AlertFeedType `json:"type" toon:"type"`
	// Last update timestamp in Unix epoch milliseconds.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
}

FeedItem is generated from the Flashduty OpenAPI schema.

type FeedSeverity 

type FeedSeverity string

FeedSeverity Severity level. 

const (
	FeedSeverityOK       FeedSeverity = "Ok"
	FeedSeverityCritical FeedSeverity = "Critical"
	FeedSeverityWarning  FeedSeverity = "Warning"
	FeedSeverityInfo     FeedSeverity = "Info"
)

func (FeedSeverity) String added in v0.5.2 

func (e FeedSeverity) String() string

String returns the underlying string value, implementing fmt.Stringer.

type FieldDeleteReference added in v0.5.7 

type FieldDeleteReference struct {
	// Console URL for the referencing custom form.
	Href string `json:"href" toon:"href"`
	// Referenced resource kind. Always `custom_form` for this response.
	Kind string `json:"kind" toon:"kind"`
	// Human label of the referencing custom form's type (a Chinese label, e.g. `解决故障` for the resolve form).
	Name string `json:"name" toon:"name"`
}

FieldDeleteReference is generated from the Flashduty OpenAPI schema.

type FieldDeleteReferenceError added in v0.5.7 

type FieldDeleteReferenceError struct {
	// Supplementary error payload; for this error it always contains the `refs` field.
	Data  FieldDeleteReferenceErrorData `json:"data" toon:"data"`
	Error any                           `json:"error" toon:"error"`
	// Trace ID of this request, identical to the `Flashcat-Request-Id` response header.
	RequestID string `json:"request_id" toon:"request_id"`
}

FieldDeleteReferenceError is generated from the Flashduty OpenAPI schema.

type FieldDeleteReferenceErrorData added in v0.5.7 

type FieldDeleteReferenceErrorData struct {
	// Custom forms that still reference the field, each with `kind`/`name`/`href`; all references must be removed before the field can be deleted.
	Refs []FieldDeleteReference `json:"refs" toon:"refs"`
}

FieldDeleteReferenceErrorData is generated from the Flashduty OpenAPI schema.

type FieldInfoRequest 

type FieldInfoRequest struct {
	// Field ID — 24-character hex ObjectID.
	FieldID string `json:"field_id" toon:"field_id"`
}

FieldInfoRequest is generated from the Flashduty OpenAPI schema.

type FieldItem 

type FieldItem struct {
	// Owning account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Creation timestamp, Unix seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Creator member ID.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Default value. Type depends on `field_type`: `bool` for checkbox; `string` for single_select/text; `string[]` for multi_select; may be `null` if no default.
	DefaultValue any `json:"default_value" toon:"default_value"`
	// Deletion timestamp, Unix seconds. Only present for soft-deleted fields.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Optional free-text description.
	Description string `json:"description" toon:"description"`
	// Human-readable name shown in the UI.
	DisplayName string `json:"display_name" toon:"display_name"`
	// Field ID — 24-character hex ObjectID.
	FieldID string `json:"field_id" toon:"field_id"`
	// Machine name used in incident payloads under `fields.<field_name>`. Immutable.
	FieldName string `json:"field_name" toon:"field_name"`
	// Field type.
	// | Value | Meaning |
	// |---|---|
	// | `checkbox` | Checkbox; value is a bool, options are not supported. |
	// | `multi_select` | Multi-select; value is a string array, each element must be one of options. |
	// | `single_select` | Single-select; value is a string from options. |
	// | `text` | Free text; value is a string. |
	FieldType string `json:"field_type" toon:"field_type"`
	// Allowed choices for `single_select`/`multi_select` (non-empty unique string array). `null` or empty for `checkbox`/`text`.
	Options []string `json:"options" toon:"options"`
	// Field status: `enabled` (active), `disabled` (set only via internal helpers, not via the API), or `deleted` (soft-deleted). `/field/list` excludes `deleted`; `/field/info` may return it.
	Status string `json:"status" toon:"status"`
	// Last update timestamp, Unix seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Last updater member ID.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
	// Value type. `checkbox` is always `bool`; `single_select`/`multi_select`/`text` are always `string`. `float` is reserved and never occurs today.
	ValueType string `json:"value_type" toon:"value_type"`
}

FieldItem is generated from the Flashduty OpenAPI schema.

type FieldListRequest 

type FieldListRequest struct {
	// Sort ascending when `true`; descending otherwise.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by creator member ID. Omit or send `null` to skip.
	CreatorID *int64 `json:"creator_id,omitempty" toon:"creator_id,omitempty"`
	// Sort key. Defaults to `created_at` when omitted.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Regex filter matched against `field_name` only. An invalid regex is auto-escaped to a literal substring match.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
}

FieldListRequest is generated from the Flashduty OpenAPI schema.

type FieldListResponse 

type FieldListResponse struct {
	// All non-deleted custom fields for the account. No pagination.
	Items []FieldItem `json:"items" toon:"items"`
}

FieldListResponse is generated from the Flashduty OpenAPI schema.

type FilterCondition 

type FilterCondition struct {
	// Field name to filter on. Use plain names for built-in alert fields (e.g. `alert_severity`, `alert_key`, `check`, `resource`, `service`, `cluster`) or the `labels.<name>` prefix for custom alert labels (e.g. `labels.env`, `labels.region`).
	Key string `json:"key" toon:"key"`
	// Filter operator. `IN` — value must match one of `vals`; `NOTIN` — value must not match any of `vals`. Supports regex patterns wrapped in `/pattern/`.
	Oper string `json:"oper" toon:"oper"`
	// List of values to match against. Each entry is a plain string or a `/regex/` pattern.
	Vals []string `json:"vals" toon:"vals"`
}

FilterCondition is generated from the Flashduty OpenAPI schema.

type FilterGroup 

type FilterGroup = OrFilterGroup

FilterGroup is an alias for OrFilterGroup.

type Flapping 

type Flapping struct {
	// Observation window in minutes.
	InMins int64 `json:"in_mins,omitempty" toon:"in_mins,omitempty"`
	// Disable flapping detection.
	IsDisabled bool `json:"is_disabled,omitempty" toon:"is_disabled,omitempty"`
	// Max state changes allowed within `in_mins`.
	MaxChanges int64 `json:"max_changes,omitempty" toon:"max_changes,omitempty"`
	// Mute duration in minutes after flapping is detected.
	MuteMins int64 `json:"mute_mins,omitempty" toon:"mute_mins,omitempty"`
}

Flapping is generated from the Flashduty OpenAPI schema.

type GetWarRoomDefaultObserversRequest added in v0.4.0 

type GetWarRoomDefaultObserversRequest struct {
	// Incident ID, a MongoDB ObjectID hex string.
	IncidentID string `json:"incident_id" toon:"incident_id"`
}

GetWarRoomDefaultObserversRequest is generated from the Flashduty OpenAPI schema.

type GetWarRoomDefaultObserversResponse added in v0.4.0 

type GetWarRoomDefaultObserversResponse struct {
	// Historical responders suggested as default war-room observers.
	Observers []WarRoomPersonItem `json:"observers" toon:"observers"`
}

GetWarRoomDefaultObserversResponse is generated from the Flashduty OpenAPI schema.

type GetWarRoomDetailRequest 

type GetWarRoomDetailRequest struct {
	// Chat ID of the IM group hosting the war room; obtain it from `POST /incident/war-room/list`.
	ChatID string `json:"chat_id" toon:"chat_id"`
	// IM integration ID that hosts the war room.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
}

GetWarRoomDetailRequest is generated from the Flashduty OpenAPI schema.

type GetWebhookHistoryDetailRequest 

type GetWebhookHistoryDetailRequest struct {
	// Event ID returned by `ListWebhookHistory`.
	EventID string `json:"event_id" toon:"event_id"`
	// Integration ID the event belongs to; available in the items returned by `POST /webhook/history/list`.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
}

GetWebhookHistoryDetailRequest is generated from the Flashduty OpenAPI schema.

type Group 

type Group struct {
	// When true, all listed keys must be present for grouping.
	AllEqualsRequired bool `json:"all_equals_required,omitempty" toon:"all_equals_required,omitempty"`
	// Per-filter grouping overrides.
	Cases []GroupCasesItem `json:"cases,omitempty" toon:"cases,omitempty"`
	// Groups of label keys whose equality defines a bucket.
	Equals [][]string `json:"equals,omitempty" toon:"equals,omitempty"`
	// Label keys used for intelligent grouping embeddings.
	IKeys []string `json:"i_keys,omitempty" toon:"i_keys,omitempty"`
	// Intelligent grouping similarity threshold.
	IScoreThreshold float64 `json:"i_score_threshold,omitempty" toon:"i_score_threshold,omitempty"`
	// Grouping method: `i` intelligent, `p` pattern, `n` none.
	Method string `json:"method" toon:"method"`
	// Alert storm threshold.
	StormThreshold int64 `json:"storm_threshold,omitempty" toon:"storm_threshold,omitempty"`
	// Multi-level storm thresholds.
	StormThresholds []int64 `json:"storm_thresholds,omitempty" toon:"storm_thresholds,omitempty"`
	// Grouping time window in minutes. Default max is 1440 minutes (24 h); extended accounts may allow up to 43200 minutes (30 days).
	TimeWindow int64 `json:"time_window,omitempty" toon:"time_window,omitempty"`
	// Window type, default `tumbling`. `tumbling` is a fixed window counted from incident creation — once it expires, new alerts open a new incident; `sliding` is a sliding window counted from the incident's most recent alert, extended each time a new alert merges in.
	WindowType string `json:"window_type,omitempty" toon:"window_type,omitempty"`
}

Group is generated from the Flashduty OpenAPI schema.

type GroupCasesItem added in v0.14.3 

type GroupCasesItem struct {
	// Grouping keys for matching alerts. Supported values: `title`, `description`, `severity`, or any `labels.<name>`.
	Equals []string `json:"equals" toon:"equals"`
	// AND-ed match conditions evaluated against stored alert fields.
	If []FilterCondition `json:"if" toon:"if"`
}

GroupCasesItem is generated from the Flashduty OpenAPI schema.

type IDRequest 

type IDRequest struct {
	// Numeric ID of the target resource; the exact meaning depends on the API being called (e.g. datasource ID, ruleset ID).
	ID uint64 `json:"id" toon:"id"`
}

IDRequest is generated from the Flashduty OpenAPI schema.

type ImIntegrationsService added in v0.4.0 

type ImIntegrationsService service

ImIntegrationsService handles the "On-call/IM integrations" API resource.

func (*ImIntegrationsService) List added in v0.4.0 

func (s *ImIntegrationsService) List(ctx context.Context) (*ListWarRoomEnabledResponse, *Response, error)

List war-room-enabled IM integrations.

List IM integrations that have the war-room feature enabled for the account.

API: POST /datasource/im/war-room-enabled/list (im-war-room-enabled-list).

type Image 

type Image struct {
	// Alt text.
	Alt string `json:"alt" toon:"alt"`
	// Optional link the image points to.
	Href string `json:"href" toon:"href"`
	// Image source. Either an `img_` upload token or an `http(s)` URL.
	Src string `json:"src" toon:"src"`
}

Image is generated from the Flashduty OpenAPI schema.

type ImportStatusPageSubscriberItem 

type ImportStatusPageSubscriberItem struct {
	// When true, the subscriber receives notifications for all components. Must be true when `component_ids` and `change_ids` are both empty.
	All bool `json:"all,omitempty" toon:"all,omitempty"`
	// Specific event IDs the subscriber should receive notifications for.
	ChangeIDs []int64 `json:"change_ids,omitempty" toon:"change_ids,omitempty"`
	// Component IDs the subscriber should receive notifications for.
	ComponentIDs []string `json:"component_ids,omitempty" toon:"component_ids,omitempty"`
	// Preferred locale for notifications. Defaults to the request locale when omitted.
	Locale string `json:"locale,omitempty" toon:"locale,omitempty"`
	// Email address (for public pages) or user ID (for internal pages).
	Recipient string `json:"recipient" toon:"recipient"`
}

ImportStatusPageSubscriberItem is generated from the Flashduty OpenAPI schema.

type ImportStatusPageSubscribersRequest 

type ImportStatusPageSubscribersRequest struct {
	// Subscription method. `email` is only valid for public pages; `im` is only valid for internal pages.
	Method string `json:"method" toon:"method"`
	// Target status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Subscribers to import.
	Subscribers []ImportStatusPageSubscriberItem `json:"subscribers,omitempty" toon:"subscribers,omitempty"`
}

ImportStatusPageSubscribersRequest is generated from the Flashduty OpenAPI schema.

type IncProgressCnts 

type IncProgressCnts struct {
	// Count of processing incidents in the last 30 days.
	Processing int64 `json:"Processing" toon:"Processing"`
	// Count of triggered incidents in the last 30 days.
	Triggered int64 `json:"Triggered" toon:"Triggered"`
}

IncProgressCnts is generated from the Flashduty OpenAPI schema.

type IncidentActionImage added in v0.5.7 

type IncidentActionImage struct {
	// Alternative text for the image.
	Alt string `json:"alt,omitempty" toon:"alt,omitempty"`
	// Optional link that the image points to.
	Href string `json:"href,omitempty" toon:"href,omitempty"`
	// Image source. Accepts an `img_` upload token, an `http(s)` URL, or an object-storage key beginning with `/`.
	Src string `json:"src" toon:"src"`
}

IncidentActionImage is generated from the Flashduty OpenAPI schema.

type IncidentCardHiddenFields added in v0.5.7 

type IncidentCardHiddenFields map[string][]string

IncidentCardHiddenFields is a map response payload.

type IncidentCommentTypeDisplay added in v0.8.0 

type IncidentCommentTypeDisplay struct {
	// Badge color in #RRGGBB format.
	Color string `json:"color" toon:"color"`
	// Comment type ID (MongoDB ObjectID).
	ID string `json:"id" toon:"id"`
	// Display name of the comment type.
	Name string `json:"name" toon:"name"`
}

IncidentCommentTypeDisplay is generated from the Flashduty OpenAPI schema.

type IncidentCommentTypeItem added in v0.8.0 

type IncidentCommentTypeItem struct {
	// Account ID that owns the comment type.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Label color as a hex value in #RRGGBB format (stored uppercase).
	Color string `json:"color" toon:"color"`
	// Comment type ID (24-character hex ObjectID).
	CommentTypeID string `json:"comment_type_id" toon:"comment_type_id"`
	// Creation time as a Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// ID of the user who created the comment type.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Display name of the comment type. Unique within the account (case-insensitive, trimmed).
	Name string `json:"name" toon:"name"`
	// 1-based display position of the comment type.
	Position int64 `json:"position" toon:"position"`
	// Last update time as a Unix timestamp in seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// ID of the user who last updated the comment type.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

IncidentCommentTypeItem is generated from the Flashduty OpenAPI schema.

type IncidentFeedItem 

type IncidentFeedItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Creation timestamp in milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// User ID of the actor. `0` means system-generated.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Soft-delete timestamp (ms). Zero if not deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Type-specific payload. The concrete shape is determined by `type`; `null` when the entry has no structured detail.
	Detail any `json:"detail" toon:"detail"`
	// ObjectID of the source alert or incident this entry references.
	RefID string           `json:"ref_id" toon:"ref_id"`
	Type  IncidentFeedType `json:"type" toon:"type"`
	// Last update timestamp in milliseconds.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
}

IncidentFeedItem is generated from the Flashduty OpenAPI schema.

type IncidentFeedType 

type IncidentFeedType string

IncidentFeedType Incident timeline entry type. Each value identifies one lifecycle event; the matching `detail` payload shape is determined by this field. Incident types are prefixed with `i_`. 

const (
	IncidentFeedTypeINew         IncidentFeedType = "i_new"
	IncidentFeedTypeIAssign      IncidentFeedType = "i_assign"
	IncidentFeedTypeIARspd       IncidentFeedType = "i_a_rspd"
	IncidentFeedTypeINotify      IncidentFeedType = "i_notify"
	IncidentFeedTypeIStorm       IncidentFeedType = "i_storm"
	IncidentFeedTypeISnooze      IncidentFeedType = "i_snooze"
	IncidentFeedTypeIWake        IncidentFeedType = "i_wake"
	IncidentFeedTypeIAck         IncidentFeedType = "i_ack"
	IncidentFeedTypeIUnack       IncidentFeedType = "i_unack"
	IncidentFeedTypeIComm        IncidentFeedType = "i_comm"
	IncidentFeedTypeIRslv        IncidentFeedType = "i_rslv"
	IncidentFeedTypeIReopen      IncidentFeedType = "i_reopen"
	IncidentFeedTypeIMerge       IncidentFeedType = "i_merge"
	IncidentFeedTypeIRTitle      IncidentFeedType = "i_r_title"
	IncidentFeedTypeIRDesc       IncidentFeedType = "i_r_desc"
	IncidentFeedTypeIRImpact     IncidentFeedType = "i_r_impact"
	IncidentFeedTypeIRRc         IncidentFeedType = "i_r_rc"
	IncidentFeedTypeIRRsltn      IncidentFeedType = "i_r_rsltn"
	IncidentFeedTypeIRSeverity   IncidentFeedType = "i_r_severity"
	IncidentFeedTypeIRField      IncidentFeedType = "i_r_field"
	IncidentFeedTypeIMFlapping   IncidentFeedType = "i_m_flapping"
	IncidentFeedTypeIMReply      IncidentFeedType = "i_m_reply"
	IncidentFeedTypeICustom      IncidentFeedType = "i_custom"
	IncidentFeedTypeIWrCreate    IncidentFeedType = "i_wr_create"
	IncidentFeedTypeIWrDelete    IncidentFeedType = "i_wr_delete"
	IncidentFeedTypeIAutoRefresh IncidentFeedType = "i_auto_refresh"
	IncidentFeedTypeIWiCreated   IncidentFeedType = "i_wi_created"
	IncidentFeedTypeIWiUpdated   IncidentFeedType = "i_wi_updated"
	IncidentFeedTypeIWiAssignees IncidentFeedType = "i_wi_assignees"
	IncidentFeedTypeIWiCompleted IncidentFeedType = "i_wi_completed"
	IncidentFeedTypeIWiConverted IncidentFeedType = "i_wi_converted"
	IncidentFeedTypeIWiBound     IncidentFeedType = "i_wi_bound"
	IncidentFeedTypeIWiDeleted   IncidentFeedType = "i_wi_deleted"
	IncidentFeedTypeAMerge       IncidentFeedType = "a_merge"
)

func (IncidentFeedType) String added in v0.5.2 

func (e IncidentFeedType) String() string

String returns the underlying string value, implementing fmt.Stringer.

type IncidentInfo 

type IncidentInfo struct {
	// Account ID that owns the incident.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Account locale.
	AccountLocale string `json:"account_locale" toon:"account_locale"`
	// Account name.
	AccountName string `json:"account_name" toon:"account_name"`
	// Account time zone.
	AccountTimeZone string `json:"account_time_zone" toon:"account_time_zone"`
	// Unix timestamp (seconds) when the incident was first acknowledged. 0 if unacknowledged.
	AckTime Timestamp `json:"ack_time" toon:"ack_time"`
	// Count of alerts currently in Critical/Warning/Info state.
	ActiveAlertCnt int64 `json:"active_alert_cnt" toon:"active_alert_cnt"`
	// AI-generated summary of the incident.
	AISummary string `json:"ai_summary" toon:"ai_summary"`
	// Total count of alerts merged into this incident.
	AlertCnt int64 `json:"alert_cnt" toon:"alert_cnt"`
	// Total raw alert event count across all merged alerts.
	AlertEventCnt int64 `json:"alert_event_cnt" toon:"alert_event_cnt"`
	// Embedded alerts, only populated for notification templates and custom actions.
	Alerts []AlertInfo `json:"alerts" toon:"alerts"`
	// Current assignment target for the incident.
	AssignedTo AssignedTo `json:"assigned_to" toon:"assigned_to"`
	// Channel ID. 0 for standalone incidents.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel display name.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Channel status.
	ChannelStatus string `json:"channel_status" toon:"channel_status"`
	// Unix timestamp (seconds) when the incident was closed. 0 if still open.
	CloseTime Timestamp `json:"close_time" toon:"close_time"`
	// Closer member info.
	Closer PersonShort `json:"closer" toon:"closer"`
	// Member ID that closed the incident. 0 if auto-closed.
	CloserID int64 `json:"closer_id" toon:"closer_id"`
	// Creation timestamp (seconds).
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Creator member info.
	Creator PersonShort `json:"creator" toon:"creator"`
	// Member ID that created the incident. 0 if auto-created by the system.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Deprecated. Use `integration_id` instead.
	DataSourceID int64 `json:"data_source_id" toon:"data_source_id"`
	// Deprecated. Use `integration_ids` instead.
	DataSourceIDs []int64 `json:"data_source_ids" toon:"data_source_ids"`
	// Deprecated. Use `integration_type` instead.
	DataSourceType string `json:"data_source_type" toon:"data_source_type"`
	// Deprecated. Use `integration_types` instead.
	DataSourceTypes []string `json:"data_source_types" toon:"data_source_types"`
	// Deduplication key used to coalesce alerts.
	DedupKey string `json:"dedup_key" toon:"dedup_key"`
	// Soft-delete timestamp (seconds). Zero if not deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Incident description.
	Description string `json:"description" toon:"description"`
	// Web console URL for the incident.
	DetailURL string `json:"detail_url" toon:"detail_url"`
	// Unix timestamp (seconds) when the incident ended. 0 if still active.
	EndTime Timestamp `json:"end_time" toon:"end_time"`
	// MD5 hash used for content-equality checks.
	EqualsMD5 string `json:"equals_md5" toon:"equals_md5"`
	// Whether the incident has ever been silenced.
	EverMuted bool `json:"ever_muted" toon:"ever_muted"`
	// Custom field values keyed by field name.
	Fields map[string]any `json:"fields" toon:"fields"`
	// Frequency bucket for recurrence analysis: `frequent` or `rare`.
	Frequency string `json:"frequency" toon:"frequency"`
	// Alert grouping method: `i` intelligent, `p` pattern, `n` none.
	GroupMethod string `json:"group_method" toon:"group_method"`
	// Attached images.
	Images []Image `json:"images" toon:"images"`
	// Impact description.
	Impact string `json:"impact" toon:"impact"`
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Configured incident severity.
	IncidentSeverity string `json:"incident_severity" toon:"incident_severity"`
	// Current incident status, derived from alert statuses.
	IncidentStatus string `json:"incident_status" toon:"incident_status"`
	// First integration associated with the incident.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// All integration IDs contributing alerts to this incident.
	IntegrationIDs []int64 `json:"integration_ids" toon:"integration_ids"`
	// First alert's integration type string, used by the detail page for label mappings.
	IntegrationType string `json:"integration_type" toon:"integration_type"`
	// Integration type strings for all contributing integrations.
	IntegrationTypes []string `json:"integration_types" toon:"integration_types"`
	// Labels propagated from alerts.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Unix timestamp (seconds) of the most recent update.
	LastTime Timestamp `json:"last_time" toon:"last_time"`
	// Channel-level link integrations rendered for this incident.
	Links []LinkItem `json:"links" toon:"links"`
	// Fields that were manually overridden after auto-population.
	ManualOverrides []string `json:"manual_overrides" toon:"manual_overrides"`
	// Short display identifier; not guaranteed unique.
	Num string `json:"num" toon:"num"`
	// Owner member info. May be deprecated.
	Owner PersonShort `json:"owner" toon:"owner"`
	// Primary owner member ID. 0 if none.
	OwnerID int64 `json:"owner_id" toon:"owner_id"`
	// Associated post-mortem ID, if any. One incident can only link to a single post-mortem.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Incident progress. `Triggered` means fired and unacknowledged; `Processing` means acknowledged and being handled (un-acknowledging moves it back to `Triggered`); `Closed` means resolved.
	Progress string `json:"progress" toon:"progress"`
	// Reporter email for manually created incidents.
	ReporterEmail string `json:"reporter_email" toon:"reporter_email"`
	// Resolution notes.
	Resolution string `json:"resolution" toon:"resolution"`
	// Current responders with assignment/acknowledgement state.
	Responders []Responder `json:"responders" toon:"responders"`
	// Root cause analysis.
	RootCause string `json:"root_cause" toon:"root_cause"`
	// Quick-silence URL for this incident.
	SilenceURL string `json:"silence_url" toon:"silence_url"`
	// Unix timestamp (seconds) until which notifications are snoozed. 0 if not snoozed.
	SnoozedBefore Timestamp `json:"snoozed_before" toon:"snoozed_before"`
	// Unix timestamp (seconds) when the incident started.
	StartTime Timestamp `json:"start_time" toon:"start_time"`
	// ID of the team that owns the incident's channel. 0 when the channel has no team.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Incident title.
	Title string `json:"title" toon:"title"`
	// Last update timestamp (seconds).
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

IncidentInfo is generated from the Flashduty OpenAPI schema.

type IncidentInfoRequest 

type IncidentInfoRequest struct {
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id,omitempty" toon:"incident_id,omitempty"`
	// Short incident ID (the 6-character uppercased id shown in the UI). Not unique — resolves to the most recent match. Supply either incident_id or num.
	Num string `json:"num,omitempty" toon:"num,omitempty"`
}

IncidentInfoRequest is generated from the Flashduty OpenAPI schema.

type IncidentListResponse 

type IncidentListResponse struct {
	// True when more results are available beyond this page.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Incident list for the current page.
	Items []IncidentInfo `json:"items" toon:"items"`
	// Opaque cursor to pass as `search_after_ctx` on the next request.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total number of matching incidents.
	Total int64 `json:"total" toon:"total"`
}

IncidentListResponse is generated from the Flashduty OpenAPI schema.

type IncidentRawItem 

type IncidentRawItem struct {
	// Number of acknowledgements.
	Acknowledgements int64 `json:"acknowledgements" toon:"acknowledgements"`
	// Number of alerts still active (not recovered).
	ActiveAlertCnt int64 `json:"active_alert_cnt" toon:"active_alert_cnt"`
	// Total number of alerts aggregated into the incident.
	AlertCnt int64 `json:"alert_cnt" toon:"alert_cnt"`
	// Total number of alert events associated with the incident; each report of an alert counts as one event.
	AlertEventCnt int64 `json:"alert_event_cnt" toon:"alert_event_cnt"`
	// Current assignment target for the incident; `null` when the incident has no assignment record.
	AssignedTo *IncidentRawItemAssignedTo `json:"assigned_to" toon:"assigned_to"`
	// Number of assignments.
	Assignments int64 `json:"assignments" toon:"assignments"`
	// ID of the channel the incident belongs to.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Name of the channel the incident belongs to.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// How the incident was closed: `auto`, `timeout`, or `manually`. Empty string while the incident is still open.
	ClosedBy string `json:"closed_by" toon:"closed_by"`
	// Member ID of the person who closed the incident. Omitted when 0 (not closed manually).
	CloserID int64 `json:"closer_id" toon:"closer_id"`
	// Display name of the person who closed the incident. Omitted when empty.
	CloserName string `json:"closer_name" toon:"closer_name"`
	// Incident creation time, as a Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Person ID of the incident creator.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Display name of the incident creator.
	CreatorName string `json:"creator_name" toon:"creator_name"`
	// Incident description. Omitted when empty.
	Description string `json:"description" toon:"description"`
	// Total engaged time in seconds across acknowledged responders, each contributing close time minus their acknowledgement time; 0 if not closed.
	EngagedSeconds int64 `json:"engaged_seconds" toon:"engaged_seconds"`
	// Total escalations, the sum of `timeout_escalations` and `manual_escalations`.
	Escalations int64 `json:"escalations" toon:"escalations"`
	// Whether the incident was ever muted by noise reduction. Omitted when false.
	EverMuted bool `json:"ever_muted" toon:"ever_muted"`
	// Custom fields of the incident. Always omitted in this response (reserved for export).
	Fields map[string]any `json:"fields" toon:"fields"`
	// Frequency classification: `frequent` or `rare`. Omitted when not classified.
	Frequency string `json:"frequency" toon:"frequency"`
	// Time-of-day bucket of the creation time in the account timezone: `work` = Mon–Fri 08:00–19:00, `sleep` = 23:00–08:00 daily, `off` = all other times.
	Hours string `json:"hours" toon:"hours"`
	// Incident ID, unique within the account.
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Number of interruptions: notifications sent via app push, SMS, or voice call; consecutive notifications to the same responder within 60 seconds count as one.
	Interruptions int64 `json:"interruptions" toon:"interruptions"`
	// Incident labels as key-value pairs. Always omitted in this response (reserved for export).
	Labels map[string]string `json:"labels" toon:"labels"`
	// Manually triggered escalations.
	ManualEscalations int64 `json:"manual_escalations" toon:"manual_escalations"`
	// Total number of notifications sent.
	Notifications int64 `json:"notifications" toon:"notifications"`
	// Member ID of the incident owner. Omitted when 0 (no owner).
	OwnerID int64 `json:"owner_id" toon:"owner_id"`
	// Display name of the incident owner. Omitted when empty.
	OwnerName string `json:"owner_name" toon:"owner_name"`
	// Incident progress state — one of `Triggered`, `Processing`, `Closed`.
	Progress string `json:"progress" toon:"progress"`
	// Number of reassignments.
	Reassignments int64 `json:"reassignments" toon:"reassignments"`
	// Responders with per-person assignment and acknowledgement times.
	Responders []IncidentRawItemRespondersItem `json:"responders" toon:"responders"`
	// Seconds from incident creation to the first acknowledgement; 0 if never acknowledged.
	SecondsToAck int64 `json:"seconds_to_ack" toon:"seconds_to_ack"`
	// Seconds from incident creation to close; 0 if not closed.
	SecondsToClose int64 `json:"seconds_to_close" toon:"seconds_to_close"`
	// Incident severity.
	Severity string `json:"severity" toon:"severity"`
	// Unix timestamp in seconds until which the incident is snoozed. Omitted when the incident is not snoozed.
	SnoozedBefore Timestamp `json:"snoozed_before" toon:"snoozed_before"`
	// ID of the team that owns the incident.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Name of the team that owns the incident.
	TeamName string `json:"team_name" toon:"team_name"`
	// Escalations triggered by timeout.
	TimeoutEscalations int64 `json:"timeout_escalations" toon:"timeout_escalations"`
	// Incident title.
	Title string `json:"title" toon:"title"`
}

IncidentRawItem is generated from the Flashduty OpenAPI schema.

type IncidentRawItemAssignedTo 

type IncidentRawItemAssignedTo struct {
	// Unix timestamp (seconds) when this assignment was made.
	AssignedAt Timestamp `json:"assigned_at" toon:"assigned_at"`
	// Escalation rule ID (MongoDB ObjectID) driving the assignment.
	EscalateRuleID string `json:"escalate_rule_id" toon:"escalate_rule_id"`
	// Display name of the escalation rule.
	EscalateRuleName string `json:"escalate_rule_name" toon:"escalate_rule_name"`
	// Internal assignment record ID.
	ID string `json:"id" toon:"id"`
	// Current level index within the escalation rule.
	LayerIdx int64 `json:"layer_idx" toon:"layer_idx"`
	// Member IDs assigned directly to this incident.
	PersonIDs []int64 `json:"person_ids" toon:"person_ids"`
	// Assignment type.
	// | Value | Meaning |
	// |---|---|
	// | `assign` | Initial assignment when the incident is created manually. |
	// | `reassign` | Re-assignment of an existing incident. |
	// | `escalate` | Assignment triggered by escalation policy advancement. |
	// | `reopen` | Assignment restarted from the first layer after the incident is reopened. |
	Type string `json:"type" toon:"type"`
}

IncidentRawItemAssignedTo is generated from the Flashduty OpenAPI schema.

type IncidentRawItemRespondersItem added in v0.14.0 

type IncidentRawItemRespondersItem struct {
	// Acknowledgement time, as a Unix timestamp in seconds; 0 if not acknowledged.
	AcknowledgedAt Timestamp `json:"acknowledged_at" toon:"acknowledged_at"`
	// Responder's identity in an external chat tool (e.g. Slack); only present when backfilled by an external system.
	As string `json:"as" toon:"as"`
	// Assignment time, as a Unix timestamp in seconds.
	AssignedAt Timestamp `json:"assigned_at" toon:"assigned_at"`
	// Responder email. Omitted when empty.
	Email string `json:"email" toon:"email"`
	// Person ID of the responder.
	PersonID int64 `json:"person_id" toon:"person_id"`
	// Responder display name. Omitted when empty.
	PersonName string `json:"person_name" toon:"person_name"`
}

IncidentRawItemRespondersItem is generated from the Flashduty OpenAPI schema.

type IncidentShort 

type IncidentShort struct {
	// Incident ID (ObjectID hex string).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Incident progress — one of `Triggered`, `Processing`, `Closed`.
	Progress string `json:"progress" toon:"progress"`
	// Incident title.
	Title string `json:"title" toon:"title"`
}

IncidentShort is generated from the Flashduty OpenAPI schema.

type IncidentsPostMortemInfoRequest 

type IncidentsPostMortemInfoRequest struct {
	// Post-mortem ID. Deterministic hash derived from account ID and the set of linked incident IDs.
	PostMortemID string `url:"post_mortem_id"`
}

IncidentsPostMortemInfoRequest holds the query parameters for Get post-mortem.

type IncidentsPostmortemReadTemplateInfoRequest added in v0.5.4 

type IncidentsPostmortemReadTemplateInfoRequest struct {
	// Template ID.
	TemplateID string `url:"template_id"`
}

IncidentsPostmortemReadTemplateInfoRequest holds the query parameters for Get post-mortem template detail.

type IncidentsService 

type IncidentsService service

IncidentsService handles the "On-call/Incidents" API resource.

func (*IncidentsService) Ack 

func (s *IncidentsService) Ack(ctx context.Context, req *AckIncidentRequest) (*Response, error)

Acknowledge incident.

Acknowledge an incident to indicate you are actively working on it.

API: POST /incident/ack (incidentAck).

func (*IncidentsService) AlertList 

func (s *IncidentsService) AlertList(ctx context.Context, req *ListIncidentAlertsRequest) (*ListIncidentAlertsResponse, *Response, error)

List alerts of incident.

List all alerts merged into a specific incident.

API: POST /incident/alert/list (incidentAlertList).

func (*IncidentsService) Assign 

func (s *IncidentsService) Assign(ctx context.Context, req *AssignIncidentRequest) (*Response, error)

Assign incident.

Dispatch an incident to a specific escalation level or responder.

API: POST /incident/assign (incidentAssign).

func (*IncidentsService) Comment 

func (s *IncidentsService) Comment(ctx context.Context, req *CommentIncidentRequest) (*Response, error)

Add comment to incident.

Add a text comment to the incident timeline.

API: POST /incident/comment (incidentComment).

func (*IncidentsService) CommentTypeCreate added in v0.8.0 

func (s *IncidentsService) CommentTypeCreate(ctx context.Context, req *CreateIncidentCommentTypeRequest) (*CreateIncidentCommentTypeResponse, *Response, error)

Create a comment type.

Create a comment type that can be attached to incident comments.

API: POST /incident/comment-type/create (incidentCommentTypeCreate).

func (*IncidentsService) CommentTypeDelete added in v0.8.0 

func (s *IncidentsService) CommentTypeDelete(ctx context.Context, req *DeleteIncidentCommentTypeRequest) (*Response, error)

Delete a comment type.

Delete a comment type. Comments that used it keep their text but lose the type label.

API: POST /incident/comment-type/delete (incidentCommentTypeDelete).

func (*IncidentsService) CommentTypeList added in v0.8.0 

func (s *IncidentsService) CommentTypeList(ctx context.Context) (*ListIncidentCommentTypesResponse, *Response, error)

List comment types.

Retrieve all comment types of the account, ordered by their display position.

API: POST /incident/comment-type/list (incidentCommentTypeList).

func (*IncidentsService) CommentTypeReorder added in v0.8.0 

func (s *IncidentsService) CommentTypeReorder(ctx context.Context, req *ReorderIncidentCommentTypesRequest) (*Response, error)

Reorder comment types.

Set the display order of all comment types by passing every type ID in the desired order.

API: POST /incident/comment-type/reorder (incidentCommentTypeReorder).

func (*IncidentsService) CommentTypeUpdate added in v0.8.0 

func (s *IncidentsService) CommentTypeUpdate(ctx context.Context, req *UpdateIncidentCommentTypeRequest) (*Response, error)

Update a comment type.

Update the name and/or color of an existing account comment type.

API: POST /incident/comment-type/update (incidentCommentTypeUpdate).

func (*IncidentsService) Create 

func (s *IncidentsService) Create(ctx context.Context, req *CreateIncidentRequest) (*CreateIncidentResponse, *Response, error)

Create incident.

Manually create a new incident and assign responders.

API: POST /incident/create (incidentCreate).

func (*IncidentsService) CustomActionDo 

func (s *IncidentsService) CustomActionDo(ctx context.Context, req *DoIncidentCustomActionRequest) (*DoIncidentCustomActionResponse, *Response, error)

Execute custom action.

Execute a custom action configured for an incident.

API: POST /incident/custom-action/do (incidentCustomActionDo).

func (*IncidentsService) DisableMerge 

func (s *IncidentsService) DisableMerge(ctx context.Context, req *DisableIncidentMergeRequest) (*Response, error)

Disable incident merge.

Disable automatic merging for a specific incident.

API: POST /incident/disable-merge (incidentDisableMerge).

func (*IncidentsService) Feed 

func (s *IncidentsService) Feed(ctx context.Context, req *ListIncidentFeedRequest) (*ListIncidentFeedResponse, *Response, error)

Get incident timeline.

Retrieve the timeline feed for a specific incident, including state changes, comments and system events.

API: POST /incident/feed (incidentFeed).

func (*IncidentsService) FieldReset 

func (s *IncidentsService) FieldReset(ctx context.Context, req *ResetIncidentFieldRequest) (*Response, error)

Update incident custom field.

Update a custom field value on an incident.

API: POST /incident/field/reset (incidentFieldReset).

func (*IncidentsService) Info 

func (s *IncidentsService) Info(ctx context.Context, req *IncidentInfoRequest) (*IncidentInfo, *Response, error)

Get incident detail.

Retrieve detailed information for a single incident including timeline, alerts, responders and custom fields.

API: POST /incident/info (incidentInfo).

func (*IncidentsService) List 

func (s *IncidentsService) List(ctx context.Context, req *ListIncidentsRequest) (*IncidentListResponse, *Response, error)

List incidents.

Query a paginated list of incidents with filters by channel, severity, status, responder, and time range.

API: POST /incident/list (incidentList).

func (*IncidentsService) ListByIDs 

func (s *IncidentsService) ListByIDs(ctx context.Context, req *ListIncidentsByIDsRequest) (*IncidentListResponse, *Response, error)

List incidents by IDs.

Retrieve multiple incidents by their IDs in a single request.

API: POST /incident/list-by-ids (incidentListByIds).

func (*IncidentsService) Merge 

func (s *IncidentsService) Merge(ctx context.Context, req *MergeIncidentsRequest) (*Response, error)

Merge incidents.

Merge one or more incidents into a target incident.

API: POST /incident/merge (incidentMerge).

func (*IncidentsService) PastList 

func (s *IncidentsService) PastList(ctx context.Context, req *ListPastIncidentsRequest) (*ListPastIncidentsResponse, *Response, error)

List past incidents.

List historical incidents related to the current incident for reference during triage.

API: POST /incident/past/list (incidentPastList).

func (*IncidentsService) PostMortemDelete 

func (s *IncidentsService) PostMortemDelete(ctx context.Context, req *DeletePostMortemRequest) (*Response, error)

Delete post-mortem.

Delete a post-mortem report.

API: POST /incident/post-mortem/delete (incidentPostMortemDelete).

func (*IncidentsService) PostMortemInfo 

func (s *IncidentsService) PostMortemInfo(ctx context.Context, req *IncidentsPostMortemInfoRequest) (*PostMortemItem, *Response, error)

Get post-mortem.

Retrieve a post-mortem report by its `post_mortem_id`. List reports via `/incident/post-mortem/list` first — each row carries the incident it covers — then fetch the full report here by that id.

API: GET /incident/post-mortem/info (incidentPostMortemInfo).

func (*IncidentsService) PostMortemList 

func (s *IncidentsService) PostMortemList(ctx context.Context, req *ListPostMortemsRequest) (*ListPostMortemsResponse, *Response, error)

List post-mortems.

List post-mortem reports with optional filters.

API: POST /incident/post-mortem/list (incidentPostMortemList).

func (*IncidentsService) PostMortemWriteResetContent added in v0.5.9 

func (s *IncidentsService) PostMortemWriteResetContent(ctx context.Context, req *ResetPostMortemContentRequest) (*PostMortemContentResetResponse, *Response, error)

Reset post-mortem content.

Replace the body of a drafting post-mortem report with Markdown.

API: POST /incident/post-mortem/content/reset (incident-post-mortem-write-reset-content).

func (*IncidentsService) PostmortemReadListTemplates added in v0.5.4 

func (s *IncidentsService) PostmortemReadListTemplates(ctx context.Context, req *ListPostMortemTemplatesRequest) (*ListPostMortemTemplatesResponse, *Response, error)

List post-mortem templates.

Return built-in and custom post-mortem templates for the account.

API: POST /incident/post-mortem/template/list (postmortem-read-list-templates).

func (*IncidentsService) PostmortemReadTemplateInfo added in v0.5.4 

func (s *IncidentsService) PostmortemReadTemplateInfo(ctx context.Context, req *IncidentsPostmortemReadTemplateInfoRequest) (*PostMortemTemplate, *Response, error)

Get post-mortem template detail.

Return one post-mortem template by ID.

API: GET /incident/post-mortem/template/info (postmortem-read-template-info).

func (*IncidentsService) PostmortemWriteDeleteTemplate added in v0.5.4 

func (s *IncidentsService) PostmortemWriteDeleteTemplate(ctx context.Context, req *DeletePostMortemTemplateRequest) (*Response, error)

Delete post-mortem template.

Delete a custom post-mortem template.

API: POST /incident/post-mortem/template/delete (postmortem-write-delete-template).

func (*IncidentsService) PostmortemWriteInit added in v0.5.4 

func (s *IncidentsService) PostmortemWriteInit(ctx context.Context, req *InitPostMortemRequest) (*PostMortemItem, *Response, error)

Initialize post-mortem.

Create a post-mortem draft from one or more incidents and a template.

API: POST /incident/post-mortem/init (postmortem-write-init).

func (*IncidentsService) PostmortemWriteResetBasics added in v0.5.4 

func (s *IncidentsService) PostmortemWriteResetBasics(ctx context.Context, req *ResetPostMortemBasicsRequest) (*Response, error)

Update post-mortem basics.

Replace the incident facts stored in a post-mortem report.

API: POST /incident/post-mortem/basics/reset (postmortem-write-reset-basics).

func (*IncidentsService) PostmortemWriteResetFollowUps added in v0.5.4 

func (s *IncidentsService) PostmortemWriteResetFollowUps(ctx context.Context, req *ResetPostMortemFollowUpsRequest) (*Response, error)

Update post-mortem follow-ups.

Replace the follow-up action items on a post-mortem report.

API: POST /incident/post-mortem/follow-ups/reset (postmortem-write-reset-follow-ups).

func (*IncidentsService) PostmortemWriteResetStatus added in v0.5.4 

func (s *IncidentsService) PostmortemWriteResetStatus(ctx context.Context, req *ResetPostMortemStatusRequest) (*Response, error)

Update post-mortem status.

Set a post-mortem report to drafting or published.

API: POST /incident/post-mortem/status/reset (postmortem-write-reset-status).

func (*IncidentsService) PostmortemWriteResetTitle added in v0.5.4 

func (s *IncidentsService) PostmortemWriteResetTitle(ctx context.Context, req *ResetPostMortemTitleRequest) (*Response, error)

Update post-mortem title.

Replace the title of a post-mortem report.

API: POST /incident/post-mortem/title/reset (postmortem-write-reset-title).

func (*IncidentsService) PostmortemWriteUpsertTemplate added in v0.5.4 

func (s *IncidentsService) PostmortemWriteUpsertTemplate(ctx context.Context, req *UpsertPostMortemTemplateRequest) (*PostMortemTemplate, *Response, error)

Create or update post-mortem template.

Create a custom post-mortem template or update an existing one.

API: POST /incident/post-mortem/template/upsert (postmortem-write-upsert-template).

func (*IncidentsService) ReadGetWarRoomDefaultObservers added in v0.4.0 

func (s *IncidentsService) ReadGetWarRoomDefaultObservers(ctx context.Context, req *GetWarRoomDefaultObserversRequest) (*GetWarRoomDefaultObserversResponse, *Response, error)

Get war-room default observers.

Return historical responders suggested as default observers when opening a war room.

API: POST /incident/war-room/default-observers (incident-read-get-war-room-default-observers).

func (*IncidentsService) Remove 

func (s *IncidentsService) Remove(ctx context.Context, req *RemoveIncidentRequest) (*Response, error)

Delete an incident.

Permanently delete an incident and all associated data.

API: POST /incident/remove (incidentRemove).

func (*IncidentsService) Reopen 

func (s *IncidentsService) Reopen(ctx context.Context, req *ReopenIncidentRequest) (*Response, error)

Reopen incident.

Reopen a previously resolved incident.

API: POST /incident/reopen (incidentReopen).

func (*IncidentsService) Reset 

func (s *IncidentsService) Reset(ctx context.Context, req *UpdateIncidentFieldsRequest) (*Response, error)

Update incident fields.

Update one or more editable fields of an incident in a single call, including title, description, impact, root cause, resolution, and severity. At least one field must be provided.

API: POST /incident/reset (incidentReset).

func (*IncidentsService) Resolve 

func (s *IncidentsService) Resolve(ctx context.Context, req *ResolveIncidentRequest) (*Response, error)

Resolve incident.

Mark an incident as resolved.

API: POST /incident/resolve (incidentResolve).

func (*IncidentsService) ResponderAdd 

func (s *IncidentsService) ResponderAdd(ctx context.Context, req *AddIncidentResponderRequest) (*Response, error)

Add incident responder.

Add a responder to an existing incident.

API: POST /incident/responder/add (incidentResponderAdd).

func (*IncidentsService) ServiceDeskPlusRequestReadList added in v0.5.8 

func (s *IncidentsService) ServiceDeskPlusRequestReadList(ctx context.Context, req *ServiceDeskPlusRequestListRequest) (*ServiceDeskPlusRequestListResponse, *Response, error)

Get ServiceDeskPlus linked incidents.

List synchronization mappings between ServiceDeskPlus requests and Flashduty incidents.

API: POST /incident/sdp/request/list (incident-service-desk-plus-request-read-list).

func (*IncidentsService) Snooze 

func (s *IncidentsService) Snooze(ctx context.Context, req *SnoozeIncidentRequest) (*Response, error)

Snooze incident.

Temporarily snooze notifications for an incident until a specified time.

API: POST /incident/snooze (incidentSnooze).

func (*IncidentsService) Unack 

func (s *IncidentsService) Unack(ctx context.Context, req *UnackIncidentRequest) (*Response, error)

Unacknowledge incident.

Remove the acknowledge status from an incident.

API: POST /incident/unack (incidentUnack).

func (*IncidentsService) Wake 

func (s *IncidentsService) Wake(ctx context.Context, req *WakeIncidentRequest) (*Response, error)

Wake incident.

Cancel the snooze on an incident and resume notifications.

API: POST /incident/wake (incidentWake).

func (*IncidentsService) WarRoomCreate 

func (s *IncidentsService) WarRoomCreate(ctx context.Context, req *CreateWarRoomRequest) (*WarRoom, *Response, error)

Create war room.

Create a war room channel for collaborative incident response.

API: POST /incident/war-room/create (incidentWarRoomCreate).

func (*IncidentsService) WarRoomDelete 

func (s *IncidentsService) WarRoomDelete(ctx context.Context, req *DeleteWarRoomRequest) (*Response, error)

Delete war room.

Delete an incident war room.

API: POST /incident/war-room/delete (incidentWarRoomDelete).

func (*IncidentsService) WarRoomDetail 

func (s *IncidentsService) WarRoomDetail(ctx context.Context, req *GetWarRoomDetailRequest) (*WarRoom, *Response, error)

Get war room detail.

Retrieve the war room configuration and members for an incident.

API: POST /incident/war-room/detail (incidentWarRoomDetail).

func (*IncidentsService) WarRoomList 

func (s *IncidentsService) WarRoomList(ctx context.Context, req *ListWarRoomsRequest) (*ListWarRoomsResponse, *Response, error)

List war rooms.

List all war rooms associated with an incident.

API: POST /incident/war-room/list (incidentWarRoomList).

func (*IncidentsService) WorkItemBindPostMortem added in v0.8.0 

func (s *IncidentsService) WorkItemBindPostMortem(ctx context.Context, req *BindWorkItemPostMortemRequest) (*WorkItemListResult, *Response, error)

Bind work items to a post-mortem.

Bulk-bind an incident's converted-but-unbound follow-ups to a post-mortem.

API: POST /incident/work-item/post-mortem/bind (incidentWorkItemBindPostMortem).

func (*IncidentsService) WorkItemComplete added in v0.8.0 

func (s *IncidentsService) WorkItemComplete(ctx context.Context, req *CompleteWorkItemRequest) (*WorkItemMutationResult, *Response, error)

Complete a work item.

Mark a work item as completed by setting a client-defined target status.

API: POST /incident/work-item/complete (incidentWorkItemComplete).

func (*IncidentsService) WorkItemConvert added in v0.8.0 

func (s *IncidentsService) WorkItemConvert(ctx context.Context, req *ConvertWorkItemRequest) (*WorkItemMutationResult, *Response, error)

Convert a work item to a follow-up.

Convert an incident action item into a post-mortem follow-up in place.

API: POST /incident/work-item/convert (incidentWorkItemConvert).

func (*IncidentsService) WorkItemCreate added in v0.8.0 

func (s *IncidentsService) WorkItemCreate(ctx context.Context, req *CreateWorkItemRequest) (*WorkItemCreateResult, *Response, error)

Create a work item.

Create an action on an active incident or a follow-up on one of its post-mortems.

API: POST /incident/work-item/create (incidentWorkItemCreate).

func (*IncidentsService) WorkItemDelete added in v0.8.0 

func (s *IncidentsService) WorkItemDelete(ctx context.Context, req *DeleteWorkItemRequest) (*WorkItemMutationResult, *Response, error)

Delete a work item.

Soft-delete a work item.

API: POST /incident/work-item/delete (incidentWorkItemDelete).

func (*IncidentsService) WorkItemList added in v0.8.0 

func (s *IncidentsService) WorkItemList(ctx context.Context, req *ListWorkItemRequest) (*WorkItemListResult, *Response, error)

List work items.

List incident work items (actions and post-mortem follow-ups) with cursor pagination.

API: POST /incident/work-item/list (incidentWorkItemList).

func (*IncidentsService) WorkItemResetAssignees added in v0.8.0 

func (s *IncidentsService) WorkItemResetAssignees(ctx context.Context, req *ResetWorkItemAssigneesRequest) (*WorkItemMutationResult, *Response, error)

Reset work item assignees.

Replace a work item's entire assignee set.

API: POST /incident/work-item/assignees/reset (incidentWorkItemResetAssignees).

func (*IncidentsService) WorkItemUpdate added in v0.8.0 

func (s *IncidentsService) WorkItemUpdate(ctx context.Context, req *UpdateWorkItemRequest) (*WorkItemMutationResult, *Response, error)

Update a work item.

Partially update a work item's title, description, status, or priority.

API: POST /incident/work-item/update (incidentWorkItemUpdate).

func (*IncidentsService) WriteAddWarRoomMember added in v0.4.0 

func (s *IncidentsService) WriteAddWarRoomMember(ctx context.Context, req *AddWarRoomMemberRequest) (*string, *Response, error)

Add war-room member.

Add one or more members to the IM war room bound to an incident integration.

API: POST /incident/war-room/add-member (incident-write-add-war-room-member).

type InhibitRuleItem 

type InhibitRuleItem struct {
	// ID of the account the rule belongs to.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// ID of the channel the rule belongs to.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Creation time, Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Deletion time, Unix timestamp in seconds. Omitted unless the rule is soft-deleted; deleted rules are excluded from list responses.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Rule description.
	Description string `json:"description" toon:"description"`
	// Field keys whose values must be equal between the source (inhibiting) alert and the target (suppressed) alert, e.g. `data_source_id` or `labels.cluster`.
	Equals []string `json:"equals" toon:"equals"`
	// When true, matching alert events are discarded entirely; when false, alerts are still recorded but marked as muted by this rule.
	IsDirectlyDiscard bool `json:"is_directly_discard" toon:"is_directly_discard"`
	// Rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Conditions the source alert must match, evaluated against stored active alerts. Supported keys: `status`, `incident_status`, `alert_status`, `severity`, `incident_severity`, `alert_severity`, `title`, `description`, or any `labels.<name>`. Empty makes the rule inert.
	SourceFilters FilterGroup `json:"source_filters" toon:"source_filters"`
	// Rule status: `enabled` or `disabled`; deleted rules never appear in the list.
	Status string `json:"status" toon:"status"`
	// Conditions the incoming target alert event must match to be suppressed; empty means every event is a target.
	TargetFilters FilterGroup `json:"target_filters" toon:"target_filters"`
	// Last update time, Unix timestamp in seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// ID of the user who last updated the rule.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

InhibitRuleItem is generated from the Flashduty OpenAPI schema.

type InitPostMortemRequest added in v0.5.4 

type InitPostMortemRequest struct {
	// Incident IDs to link to the report. 1-10 incidents.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
	// Template ID used to initialize the report.
	TemplateID string `json:"template_id" toon:"template_id"`
}

InitPostMortemRequest is generated from the Flashduty OpenAPI schema.

type InsightAlertByLabelItem 

type InsightAlertByLabelItem struct {
	// Hour bucket when `split_hours` is enabled: `work`, `sleep`, or `off`. Omitted when `split_hours` is false.
	Hours string `json:"hours" toon:"hours"`
	// Aggregation key value (check name or resource identifier).
	Label string `json:"label" toon:"label"`
	// Total number of alerts in this label-value bucket.
	TotalAlertCnt int64 `json:"total_alert_cnt" toon:"total_alert_cnt"`
	// Total number of raw alert events in this label-value bucket.
	TotalAlertEventCnt int64 `json:"total_alert_event_cnt" toon:"total_alert_event_cnt"`
}

InsightAlertByLabelItem is generated from the Flashduty OpenAPI schema.

type InsightAlertByLabelResponse 

type InsightAlertByLabelResponse struct {
	// Top-K statistic rows aggregated by the requested label's values.
	Items []InsightAlertByLabelItem `json:"items" toon:"items"`
}

InsightAlertByLabelResponse is generated from the Flashduty OpenAPI schema.

type InsightFilter 

type InsightFilter struct {
	// Sort ascending when `true`, descending otherwise. Only used by `/insight/incident/list`.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by channel IDs. At most 100 entries.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Strip HTML markup from the description column when exporting.
	DescriptionHTMLToText bool `json:"description_html_to_text,omitempty" toon:"description_html_to_text,omitempty"`
	// End time, Unix seconds. Must be greater than `start_time`.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// CSV column keys to include in the export, in the given order; unknown or duplicate keys are rejected. The valid key set differs per export endpoint — see each export operation's description. Only used by the export endpoints; at most 50 entries.
	ExportFields []string `json:"export_fields,omitempty" toon:"export_fields,omitempty"`
	// Custom-field filters (exact match).
	Fields map[string]any `json:"fields,omitempty" toon:"fields,omitempty"`
	// Filter by incident IDs (MongoDB ObjectIDs). At most 100 entries.
	IncidentIDs []string `json:"incident_ids,omitempty" toon:"incident_ids,omitempty"`
	// Include incidents that have ever been muted. By default, they are excluded.
	IncludeEverMuted bool `json:"include_ever_muted,omitempty" toon:"include_ever_muted,omitempty"`
	// Restrict results to teams the caller belongs to. When true and the caller has no teams, the result set is empty.
	IsMyTeam bool `json:"is_my_team,omitempty" toon:"is_my_team,omitempty"`
	// Label filters (exact match).
	Labels map[string]string `json:"labels,omitempty" toon:"labels,omitempty"`
	// Sort field of the incident list; only `created_at` (incident creation time) is supported. Used by `/insight/incident/list` only.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Substring match on the incident title (SQL `LIKE %query%`).
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by responder person IDs. At most 100 entries.
	ResponderIDs []int64 `json:"responder_ids,omitempty" toon:"responder_ids,omitempty"`
	// Lower bound (inclusive) on time-to-acknowledge, in seconds.
	SecondsToAckFrom int64 `json:"seconds_to_ack_from,omitempty" toon:"seconds_to_ack_from,omitempty"`
	// Upper bound (exclusive) on time-to-acknowledge, in seconds. Must be greater than `seconds_to_ack_from` when both are set.
	SecondsToAckTo int64 `json:"seconds_to_ack_to,omitempty" toon:"seconds_to_ack_to,omitempty"`
	// Lower bound (inclusive) on time-to-close, in seconds.
	SecondsToCloseFrom int64 `json:"seconds_to_close_from,omitempty" toon:"seconds_to_close_from,omitempty"`
	// Upper bound (exclusive) on time-to-close, in seconds. Must be greater than `seconds_to_close_from` when both are set.
	SecondsToCloseTo int64 `json:"seconds_to_close_to,omitempty" toon:"seconds_to_close_to,omitempty"`
	// Filter by severity. At most 3 entries.
	Severities []string `json:"severities,omitempty" toon:"severities,omitempty"`
	// Start time, Unix seconds. Must be greater than 0.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Filter by team IDs. At most 100 entries.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
	// IANA time zone name used to cut day/week/month buckets (e.g. `Asia/Shanghai`). Optional; defaults to UTC, except that `/insight/incident/export` falls back to the account time zone and then `Asia/Shanghai`.
	TimeZone string `json:"time_zone,omitempty" toon:"time_zone,omitempty"`
}

InsightFilter is generated from the Flashduty OpenAPI schema.

type InsightIncidentExportRequest 

type InsightIncidentExportRequest = InsightFilter

InsightIncidentExportRequest is an alias for InsightFilter.

type InsightIncidentListRequest 

type InsightIncidentListRequest struct {
	ListOptions
	// Sort ascending when `true`, descending otherwise. Only used by `/insight/incident/list`.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by channel IDs. At most 100 entries.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Strip HTML markup from the description column when exporting.
	DescriptionHTMLToText bool `json:"description_html_to_text,omitempty" toon:"description_html_to_text,omitempty"`
	// End time, Unix seconds. Must be greater than `start_time`.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// CSV column keys to include in the export, in the given order; unknown or duplicate keys are rejected. The valid key set differs per export endpoint — see each export operation's description. Only used by the export endpoints; at most 50 entries.
	ExportFields []string `json:"export_fields,omitempty" toon:"export_fields,omitempty"`
	// Custom-field filters (exact match).
	Fields map[string]any `json:"fields,omitempty" toon:"fields,omitempty"`
	// Filter by incident IDs (MongoDB ObjectIDs). At most 100 entries.
	IncidentIDs []string `json:"incident_ids,omitempty" toon:"incident_ids,omitempty"`
	// Include incidents that have ever been muted. By default, they are excluded.
	IncludeEverMuted bool `json:"include_ever_muted,omitempty" toon:"include_ever_muted,omitempty"`
	// Restrict results to teams the caller belongs to. When true and the caller has no teams, the result set is empty.
	IsMyTeam bool `json:"is_my_team,omitempty" toon:"is_my_team,omitempty"`
	// Label filters (exact match).
	Labels map[string]string `json:"labels,omitempty" toon:"labels,omitempty"`
	// Sort field of the incident list; only `created_at` (incident creation time) is supported. Used by `/insight/incident/list` only.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Substring match on the incident title (SQL `LIKE %query%`).
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by responder person IDs. At most 100 entries.
	ResponderIDs []int64 `json:"responder_ids,omitempty" toon:"responder_ids,omitempty"`
	// Lower bound (inclusive) on time-to-acknowledge, in seconds.
	SecondsToAckFrom int64 `json:"seconds_to_ack_from,omitempty" toon:"seconds_to_ack_from,omitempty"`
	// Upper bound (exclusive) on time-to-acknowledge, in seconds. Must be greater than `seconds_to_ack_from` when both are set.
	SecondsToAckTo int64 `json:"seconds_to_ack_to,omitempty" toon:"seconds_to_ack_to,omitempty"`
	// Lower bound (inclusive) on time-to-close, in seconds.
	SecondsToCloseFrom int64 `json:"seconds_to_close_from,omitempty" toon:"seconds_to_close_from,omitempty"`
	// Upper bound (exclusive) on time-to-close, in seconds. Must be greater than `seconds_to_close_from` when both are set.
	SecondsToCloseTo int64 `json:"seconds_to_close_to,omitempty" toon:"seconds_to_close_to,omitempty"`
	// Filter by severity. At most 3 entries.
	Severities []string `json:"severities,omitempty" toon:"severities,omitempty"`
	// Start time, Unix seconds. Must be greater than 0.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Filter by team IDs. At most 100 entries.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
	// IANA time zone name used to cut day/week/month buckets (e.g. `Asia/Shanghai`). Optional; defaults to UTC, except that `/insight/incident/export` falls back to the account time zone and then `Asia/Shanghai`.
	TimeZone string `json:"time_zone,omitempty" toon:"time_zone,omitempty"`
}

InsightIncidentListRequest is generated from the Flashduty OpenAPI schema.

type InsightIncidentListResponse 

type InsightIncidentListResponse struct {
	// Whether another page of results is available.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Incident items.
	Items []IncidentRawItem `json:"items" toon:"items"`
	// Cursor token to fetch the next page — the incident ID of the last row on this page. Present only when `has_next_page` is true.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total matching incidents.
	Total int64 `json:"total" toon:"total"`
}

InsightIncidentListResponse is generated from the Flashduty OpenAPI schema.

type InsightQueryRequest 

type InsightQueryRequest struct {
	// Aggregates metrics by time granularity. When set, the time range must be at least 24 hours; with `day` granularity the range must not exceed 31 days. `day` buckets by calendar day, `week` by calendar week, and `month` by calendar month, with boundaries aligned to `time_zone`.
	AggregateUnit string `json:"aggregate_unit,omitempty" toon:"aggregate_unit,omitempty"`
	// Sort ascending when `true`, descending otherwise. Only used by `/insight/incident/list`.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by channel IDs. At most 100 entries.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Strip HTML markup from the description column when exporting.
	DescriptionHTMLToText bool `json:"description_html_to_text,omitempty" toon:"description_html_to_text,omitempty"`
	// End time, Unix seconds. Must be greater than `start_time`.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// CSV column keys to include in the export, in the given order; unknown or duplicate keys are rejected. The valid key set differs per export endpoint — see each export operation's description. Only used by the export endpoints; at most 50 entries.
	ExportFields []string `json:"export_fields,omitempty" toon:"export_fields,omitempty"`
	// Custom-field filters (exact match).
	Fields map[string]any `json:"fields,omitempty" toon:"fields,omitempty"`
	// Filter by incident IDs (MongoDB ObjectIDs). At most 100 entries.
	IncidentIDs []string `json:"incident_ids,omitempty" toon:"incident_ids,omitempty"`
	// Include incidents that have ever been muted. By default, they are excluded.
	IncludeEverMuted bool `json:"include_ever_muted,omitempty" toon:"include_ever_muted,omitempty"`
	// Restrict results to teams the caller belongs to. When true and the caller has no teams, the result set is empty.
	IsMyTeam bool `json:"is_my_team,omitempty" toon:"is_my_team,omitempty"`
	// Label filters (exact match).
	Labels map[string]string `json:"labels,omitempty" toon:"labels,omitempty"`
	// Sort field of the incident list; only `created_at` (incident creation time) is supported. Used by `/insight/incident/list` only.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Substring match on the incident title (SQL `LIKE %query%`).
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by responder person IDs. At most 100 entries.
	ResponderIDs []int64 `json:"responder_ids,omitempty" toon:"responder_ids,omitempty"`
	// Lower bound (inclusive) on time-to-acknowledge, in seconds.
	SecondsToAckFrom int64 `json:"seconds_to_ack_from,omitempty" toon:"seconds_to_ack_from,omitempty"`
	// Upper bound (exclusive) on time-to-acknowledge, in seconds. Must be greater than `seconds_to_ack_from` when both are set.
	SecondsToAckTo int64 `json:"seconds_to_ack_to,omitempty" toon:"seconds_to_ack_to,omitempty"`
	// Lower bound (inclusive) on time-to-close, in seconds.
	SecondsToCloseFrom int64 `json:"seconds_to_close_from,omitempty" toon:"seconds_to_close_from,omitempty"`
	// Upper bound (exclusive) on time-to-close, in seconds. Must be greater than `seconds_to_close_from` when both are set.
	SecondsToCloseTo int64 `json:"seconds_to_close_to,omitempty" toon:"seconds_to_close_to,omitempty"`
	// Filter by severity. At most 3 entries.
	Severities []string `json:"severities,omitempty" toon:"severities,omitempty"`
	// When true, metrics are split into `work`/`sleep`/`off` hour buckets.
	SplitHours bool `json:"split_hours,omitempty" toon:"split_hours,omitempty"`
	// Start time, Unix seconds. Must be greater than 0.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Filter by team IDs. At most 100 entries.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
	// IANA time zone name used to cut day/week/month buckets (e.g. `Asia/Shanghai`). Optional; defaults to UTC, except that `/insight/incident/export` falls back to the account time zone and then `Asia/Shanghai`.
	TimeZone string `json:"time_zone,omitempty" toon:"time_zone,omitempty"`
}

InsightQueryRequest is generated from the Flashduty OpenAPI schema.

type InsightTopkAlertByLabelRequest 

type InsightTopkAlertByLabelRequest struct {
	// Aggregates metrics by time granularity. When set, the time range must be at least 24 hours; with `day` granularity the range must not exceed 31 days. `day` buckets by calendar day, `week` by calendar week, and `month` by calendar month, with boundaries aligned to `time_zone`.
	AggregateUnit string `json:"aggregate_unit,omitempty" toon:"aggregate_unit,omitempty"`
	// Sort ascending when `true`, descending otherwise.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by channel IDs. At most 100 entries.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Strip HTML markup from the description column when exporting.
	DescriptionHTMLToText bool `json:"description_html_to_text,omitempty" toon:"description_html_to_text,omitempty"`
	// End time, Unix seconds. Must be greater than `start_time`.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// CSV column keys to include in the export, in the given order; unknown or duplicate keys are rejected. The valid key set differs per export endpoint — see each export operation's description. Only used by the export endpoints; at most 50 entries.
	ExportFields []string `json:"export_fields,omitempty" toon:"export_fields,omitempty"`
	// Custom-field filters (exact match).
	Fields map[string]any `json:"fields,omitempty" toon:"fields,omitempty"`
	// Filter by incident IDs (MongoDB ObjectIDs). At most 100 entries.
	IncidentIDs []string `json:"incident_ids,omitempty" toon:"incident_ids,omitempty"`
	// Include incidents that have ever been muted. By default, they are excluded.
	IncludeEverMuted bool `json:"include_ever_muted,omitempty" toon:"include_ever_muted,omitempty"`
	// Restrict results to teams the caller belongs to. When true and the caller has no teams, the result set is empty.
	IsMyTeam bool `json:"is_my_team,omitempty" toon:"is_my_team,omitempty"`
	// Number of top entries to return, between 1 and 100. Defaults to 20.
	K int64 `json:"k,omitempty" toon:"k,omitempty"`
	// Aggregation dimension. `check` aggregates by the event's `labels.check` label (monitoring check); `resource` aggregates by the `labels.resource` label (monitored resource identifier).
	Label string `json:"label" toon:"label"`
	// Label filters (exact match).
	Labels map[string]string `json:"labels,omitempty" toon:"labels,omitempty"`
	// Sort field. `total_alert_cnt` sorts by alert count; `total_alert_event_cnt` sorts by raw alert event count (default).
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Substring match on the incident title (SQL `LIKE %query%`).
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by responder person IDs. At most 100 entries.
	ResponderIDs []int64 `json:"responder_ids,omitempty" toon:"responder_ids,omitempty"`
	// Lower bound (inclusive) on time-to-acknowledge, in seconds.
	SecondsToAckFrom int64 `json:"seconds_to_ack_from,omitempty" toon:"seconds_to_ack_from,omitempty"`
	// Upper bound (exclusive) on time-to-acknowledge, in seconds. Must be greater than `seconds_to_ack_from` when both are set.
	SecondsToAckTo int64 `json:"seconds_to_ack_to,omitempty" toon:"seconds_to_ack_to,omitempty"`
	// Lower bound (inclusive) on time-to-close, in seconds.
	SecondsToCloseFrom int64 `json:"seconds_to_close_from,omitempty" toon:"seconds_to_close_from,omitempty"`
	// Upper bound (exclusive) on time-to-close, in seconds. Must be greater than `seconds_to_close_from` when both are set.
	SecondsToCloseTo int64 `json:"seconds_to_close_to,omitempty" toon:"seconds_to_close_to,omitempty"`
	// Filter by severity. At most 3 entries.
	Severities []string `json:"severities,omitempty" toon:"severities,omitempty"`
	// When true, metrics are split into `work`/`sleep`/`off` hour buckets.
	SplitHours bool `json:"split_hours,omitempty" toon:"split_hours,omitempty"`
	// Start time, Unix seconds. Must be greater than 0.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Filter by team IDs. At most 100 entries.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
	// IANA time zone name used to cut day/week/month buckets (e.g. `Asia/Shanghai`). Optional; defaults to UTC, except that `/insight/incident/export` falls back to the account time zone and then `Asia/Shanghai`.
	TimeZone string `json:"time_zone,omitempty" toon:"time_zone,omitempty"`
}

InsightTopkAlertByLabelRequest is generated from the Flashduty OpenAPI schema.

type IntegrationsService 

type IntegrationsService service

IntegrationsService handles the "On-call/Integrations" API resource. 

func (s *IntegrationsService) DatasourceImPersonTryLink(ctx context.Context, req *TryLinkPersonRequest) (*TryLinkPersonResponse, *Response, error)

Attempt IM person linking.

Try to automatically link unbound members to their IM accounts for one integration.

API: POST /datasource/im/person/try-link (datasourceImPersonTryLink).

func (*IntegrationsService) Detail 

func (s *IntegrationsService) Detail(ctx context.Context, req *GetWebhookHistoryDetailRequest) (*WebhookHistoryDetail, *Response, error)

Get webhook delivery detail.

Retrieve the detailed payload and response for a specific webhook delivery attempt.

API: POST /webhook/history/detail (webhookHistoryDetail).

func (*IntegrationsService) List 

func (s *IntegrationsService) List(ctx context.Context, req *ListWebhookHistoryRequest) (*ListWebhookHistoryResponse, *Response, error)

List webhook delivery history.

List the delivery history for outbound webhook notifications.

API: POST /webhook/history/list (webhookHistoryList).

type InviteMemberItem 

type InviteMemberItem struct {
	// ISO 3166-1 alpha-2 region code for `phone` (e.g. "CN"). Validated and normalized to upper case before storage; invalid values are rejected with a 400. Also the parsing hint when `phone` has no "+" prefix (defaults to "CN").
	CountryCode string `json:"country_code,omitempty" toon:"country_code,omitempty"`
	// Email address. Required when `phone` is not provided.
	Email string `json:"email,omitempty" toon:"email,omitempty"`
	// Locale. One of: `zh-CN` (Simplified Chinese), `en-US` (English); other values are rejected with a 400.
	Locale string `json:"locale,omitempty" toon:"locale,omitempty"`
	// Display name, 2–39 characters. Required when `email` is not provided; derived from the email prefix when omitted.
	MemberName string `json:"member_name,omitempty" toon:"member_name,omitempty"`
	// Phone number. Required when `email` is not provided.
	Phone string `json:"phone,omitempty" toon:"phone,omitempty"`
	// External reference ID
	RefID string `json:"ref_id,omitempty" toon:"ref_id,omitempty"`
	// Role IDs to assign
	RoleIDs []uint64 `json:"role_ids,omitempty" toon:"role_ids,omitempty"`
	// Time zone
	TimeZone string `json:"time_zone,omitempty" toon:"time_zone,omitempty"`
}

InviteMemberItem is generated from the Flashduty OpenAPI schema.

type IssuePresetSeverityRulesService added in v0.10.0 

type IssuePresetSeverityRulesService service

IssuePresetSeverityRulesService handles the "RUM/Issue preset severity rules" API resource.

func (*IssuePresetSeverityRulesService) Create added in v0.10.0 

func (s *IssuePresetSeverityRulesService) Create(ctx context.Context, req *RUMPresetSeverityRuleCreateRequest) (*RUMPresetSeverityRuleCreateResponse, *Response, error)

Create preset severity rule.

Create a new preset severity rule for a RUM application.

API: POST /rum/issue/preset-severity/rules/create (rum-issue-preset-severity-rules-create).

func (*IssuePresetSeverityRulesService) Delete added in v0.10.0 

func (s *IssuePresetSeverityRulesService) Delete(ctx context.Context, req *RUMPresetSeverityRuleIDRequest) (*Response, error)

Delete preset severity rule.

Delete a preset severity rule.

API: POST /rum/issue/preset-severity/rules/delete (rum-issue-preset-severity-rules-delete).

func (*IssuePresetSeverityRulesService) Disable added in v0.10.0 

func (s *IssuePresetSeverityRulesService) Disable(ctx context.Context, req *RUMPresetSeverityRuleIDRequest) (*Response, error)

Disable preset severity rule.

Disable a preset severity rule.

API: POST /rum/issue/preset-severity/rules/disable (rum-issue-preset-severity-rules-disable).

func (*IssuePresetSeverityRulesService) Enable added in v0.10.0 

func (s *IssuePresetSeverityRulesService) Enable(ctx context.Context, req *RUMPresetSeverityRuleIDRequest) (*Response, error)

Enable preset severity rule.

Enable a preset severity rule.

API: POST /rum/issue/preset-severity/rules/enable (rum-issue-preset-severity-rules-enable).

func (*IssuePresetSeverityRulesService) HistoryList added in v0.10.0 

func (s *IssuePresetSeverityRulesService) HistoryList(ctx context.Context, req *RUMPresetSeverityRuleHistoryListRequest) (*RUMPresetSeverityRuleHistoryListResponse, *Response, error)

List preset severity rule history.

Return the change history of preset severity rules for a RUM application.

API: POST /rum/issue/preset-severity/rules/history/list (rum-issue-preset-severity-rules-history-list).

func (*IssuePresetSeverityRulesService) HistoryRevert added in v0.10.0 

func (s *IssuePresetSeverityRulesService) HistoryRevert(ctx context.Context, req *RUMPresetSeverityRuleHistoryRevertRequest) (*Response, error)

Revert preset severity rules to a history snapshot.

Roll back preset severity rules to the state captured in a specific history snapshot.

API: POST /rum/issue/preset-severity/rules/history/revert (rum-issue-preset-severity-rules-history-revert).

func (*IssuePresetSeverityRulesService) List added in v0.10.0 

func (s *IssuePresetSeverityRulesService) List(ctx context.Context, req *RUMPresetSeverityRuleListRequest) (*RUMPresetSeverityRuleListResponse, *Response, error)

List preset severity rules.

Return all preset severity rules configured for a RUM application.

API: POST /rum/issue/preset-severity/rules/list (rum-issue-preset-severity-rules-list).

func (*IssuePresetSeverityRulesService) Reorder added in v0.10.0 

func (s *IssuePresetSeverityRulesService) Reorder(ctx context.Context, req *RUMPresetSeverityRuleReorderRequest) (*Response, error)

Reorder preset severity rule.

Move one preset severity rule to another rule's position in evaluation order.

API: POST /rum/issue/preset-severity/rules/reorder (rum-issue-preset-severity-rules-reorder).

func (*IssuePresetSeverityRulesService) Update added in v0.10.0 

func (s *IssuePresetSeverityRulesService) Update(ctx context.Context, req *RUMPresetSeverityRuleUpdateRequest) (*Response, error)

Update preset severity rule.

Update the name, description, filters, or severity of a preset severity rule.

API: POST /rum/issue/preset-severity/rules/update (rum-issue-preset-severity-rules-update).

type IssuesService 

type IssuesService service

IssuesService handles the "RUM/Issues" API resource.

func (*IssuesService) ReadExport added in v0.14.4 

func (s *IssuesService) ReadExport(ctx context.Context, req *RUMIssueExportRequest) (*Response, error)

Export issues as CSV.

Export the filtered RUM error tracking issues as a CSV file. The response is a `text/csv` stream delivered with `Content-Disposition: attachment` — it is not a JSON envelope; non-console callers can read the `X-Export-Total` and `X-Export-Truncated` response headers.

The success body is a file, not a JSON envelope: it is returned on Response.Raw.

API: POST /rum/issue/export (rum-issue-read-export).

func (*IssuesService) ReadInfo 

func (s *IssuesService) ReadInfo(ctx context.Context, req *RUMIssueIDRequest) (*RUMIssueItem, *Response, error)

Get issue detail.

Retrieve full details of a single issue by `issue_id`.

API: POST /rum/issue/info (rum-issue-read-info).

func (*IssuesService) ReadList 

func (s *IssuesService) ReadList(ctx context.Context, req *RUMIssueListRequest) (*RUMIssueListResponse, *Response, error)

List issues.

Return a paginated list of RUM error tracking issues matching the given filters.

API: POST /rum/issue/list (rum-issue-read-list).

func (*IssuesService) WriteUpdate 

func (s *IssuesService) WriteUpdate(ctx context.Context, req *RUMIssueUpdateRequest) (*Response, error)

Update issue.

Update the status or suspected cause of an issue.

API: POST /rum/issue/update (rum-issue-write-update).

type KnowledgeFileDeleteRequest added in v0.12.0 

type KnowledgeFileDeleteRequest struct {
	// Delete even when other pack files reference this file; the referrers are then returned as warnings instead of blocking the delete.
	Force bool `json:"force,omitempty" toon:"force,omitempty"`
	// Knowledge pack ID; defaults to the caller's account-scope pack.
	PackID string `json:"pack_id,omitempty" toon:"pack_id,omitempty"`
	// Path of the file relative to the pack root.
	RelPath string `json:"rel_path" toon:"rel_path"`
}

KnowledgeFileDeleteRequest is generated from the Flashduty OpenAPI schema.

type KnowledgeFileDeleteResponse added in v0.12.0 

type KnowledgeFileDeleteResponse struct {
	// Non-blocking warnings after deletion; `code=still_referenced_by` means the (force-)deleted file is still @ref-referenced by other files in the pack (`refs` lists the referrers). Absent when there are no warnings (omitempty).
	Warnings []KnowledgeWarning `json:"warnings" toon:"warnings"`
}

KnowledgeFileDeleteResponse is generated from the Flashduty OpenAPI schema.

type KnowledgeFileGetRequest added in v0.12.0 

type KnowledgeFileGetRequest struct {
	// Knowledge pack ID; defaults to the caller's account-scope pack.
	PackID string `json:"pack_id,omitempty" toon:"pack_id,omitempty"`
	// Path of the file relative to the pack root.
	RelPath string `json:"rel_path" toon:"rel_path"`
}

KnowledgeFileGetRequest is generated from the Flashduty OpenAPI schema.

type KnowledgeFileGetResponse added in v0.12.0 

type KnowledgeFileGetResponse struct {
	// Base64-encoded file content; decodes to UTF-8 text.
	ContentB64 string            `json:"content_b64" toon:"content_b64"`
	File       KnowledgeFileItem `json:"file" toon:"file"`
}

KnowledgeFileGetResponse is generated from the Flashduty OpenAPI schema.

type KnowledgeFileItem added in v0.12.0 

type KnowledgeFileItem struct {
	// SHA-256 hex digest of the file content.
	Checksum string `json:"checksum" toon:"checksum"`
	// MIME type; inferred from the file extension when not set on upload.
	ContentType string `json:"content_type" toon:"content_type"`
	// File ID (`kfl_` prefix).
	FileID string `json:"file_id" toon:"file_id"`
	// ID of the knowledge pack that contains the file.
	PackID string `json:"pack_id" toon:"pack_id"`
	// Path relative to the pack root, e.g. `runbooks/restart.md`.
	RelPath string `json:"rel_path" toon:"rel_path"`
	// File size in bytes.
	SizeBytes int64 `json:"size_bytes" toon:"size_bytes"`
	// Unix timestamp in milliseconds when the file was last modified.
	UpdatedAtMs TimestampMilli `json:"updated_at_ms" toon:"updated_at_ms"`
	// Person ID of the member who last modified the file.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

KnowledgeFileItem is generated from the Flashduty OpenAPI schema.

type KnowledgeFileListRequest added in v0.12.0 

type KnowledgeFileListRequest struct {
	ListOptions
	// Knowledge pack ID; defaults to the caller's account-scope pack.
	PackID string `json:"pack_id,omitempty" toon:"pack_id,omitempty"`
}

KnowledgeFileListRequest is generated from the Flashduty OpenAPI schema.

type KnowledgeFileListResponse added in v0.12.0 

type KnowledgeFileListResponse struct {
	// Array of files in the specified knowledge pack; empty array when the pack has no files.
	Files []KnowledgeFileItem `json:"files" toon:"files"`
	// Total number of files in the pack.
	Total int64 `json:"total" toon:"total"`
}

KnowledgeFileListResponse is generated from the Flashduty OpenAPI schema.

type KnowledgeFilePutRequest added in v0.12.0 

type KnowledgeFilePutRequest struct {
	// Base64-encoded file content; must decode to valid UTF-8 text (binary is rejected). Per-file limit 1 MiB.
	ContentB64 string `json:"content_b64,omitempty" toon:"content_b64,omitempty"`
	// MIME type; inferred from the file extension when omitted.
	ContentType string `json:"content_type,omitempty" toon:"content_type,omitempty"`
	// Knowledge pack ID; defaults to the caller's account-scope pack.
	PackID string `json:"pack_id,omitempty" toon:"pack_id,omitempty"`
	// Destination path relative to the pack root; existing files are overwritten.
	RelPath string `json:"rel_path" toon:"rel_path"`
}

KnowledgeFilePutRequest is generated from the Flashduty OpenAPI schema.

type KnowledgeFilePutResponse added in v0.12.0 

type KnowledgeFilePutResponse struct {
	File KnowledgeFileItem `json:"file" toon:"file"`
	// Non-blocking warnings after a successful write; `code=unresolved_reference` means an @ref in the file content points to a file that does not exist in the pack. Absent when there are no warnings (omitempty).
	Warnings []KnowledgeWarning `json:"warnings" toon:"warnings"`
}

KnowledgeFilePutResponse is generated from the Flashduty OpenAPI schema.

type KnowledgeGetRequest added in v0.12.0 

type KnowledgeGetRequest struct{}

KnowledgeGetRequest is generated from the Flashduty OpenAPI schema.

type KnowledgeGetResponse added in v0.12.0 

type KnowledgeGetResponse struct {
	// Array of files in this knowledge pack; empty array when the pack has no files.
	Files []KnowledgeFileItem `json:"files" toon:"files"`
	Pack  KnowledgePackItem   `json:"pack" toon:"pack"`
}

KnowledgeGetResponse is generated from the Flashduty OpenAPI schema.

type KnowledgePackDeleteRequest added in v0.12.0 

type KnowledgePackDeleteRequest struct {
	// Knowledge pack ID to delete.
	PackID string `json:"pack_id" toon:"pack_id"`
}

KnowledgePackDeleteRequest is generated from the Flashduty OpenAPI schema.

type KnowledgePackDeleteResponse added in v0.12.0 

type KnowledgePackDeleteResponse struct {
	// True when the pack was deleted.
	OK bool `json:"ok" toon:"ok"`
}

KnowledgePackDeleteResponse is generated from the Flashduty OpenAPI schema.

type KnowledgePackEnsureRequest added in v0.12.0 

type KnowledgePackEnsureRequest struct {
	// Scope of the pack to ensure. One of: `account` (account-level pack; scope_id is forced to the caller's account ID and only account admins may create it; first creation seeds a default DUTY.md), `team` (team-level pack; the `scope_id` team ID is required and the caller must belong to that team).
	Scope string `json:"scope" toon:"scope"`
	// Team ID; required for `team` scope, ignored for `account` scope.
	ScopeID int64 `json:"scope_id,omitempty" toon:"scope_id,omitempty"`
}

KnowledgePackEnsureRequest is generated from the Flashduty OpenAPI schema.

type KnowledgePackItem added in v0.12.0 

type KnowledgePackItem struct {
	// Account that owns the pack.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Whether the caller can edit this pack.
	CanEdit bool `json:"can_edit" toon:"can_edit"`
	// Unix timestamp in milliseconds when the pack was created.
	CreatedAtMs TimestampMilli `json:"created_at_ms" toon:"created_at_ms"`
	// Person ID of the member who created the pack.
	CreatedBy int64 `json:"created_by" toon:"created_by"`
	// Pack version at which DUTY.md was last authored or re-affirmed. When `version` is greater, DUTY.md no longer reflects every file in the pack.
	DutyVersion int64 `json:"duty_version" toon:"duty_version"`
	// Number of files in the pack.
	FileCount int64 `json:"file_count" toon:"file_count"`
	// Knowledge pack ID (`kpk_` prefix).
	PackID string `json:"pack_id" toon:"pack_id"`
	// Pack scope. `channel` is a legacy scope; new packs are `account` or `team`.
	Scope string `json:"scope" toon:"scope"`
	// Scope owner: the account ID for `account` scope, the team ID for `team` scope.
	ScopeID int64 `json:"scope_id" toon:"scope_id"`
	// Display name of the owning team (team scope only). Omitted when empty (account scope, or the team name could not be resolved).
	TeamName string `json:"team_name" toon:"team_name"`
	// Total size of all files in bytes.
	TotalBytes int64 `json:"total_bytes" toon:"total_bytes"`
	// Unix timestamp in milliseconds when the pack was last modified.
	UpdatedAtMs TimestampMilli `json:"updated_at_ms" toon:"updated_at_ms"`
	// Pack version, incremented on every file change.
	Version int64 `json:"version" toon:"version"`
}

KnowledgePackItem is generated from the Flashduty OpenAPI schema.

type KnowledgePackListRequest added in v0.12.0 

type KnowledgePackListRequest struct {
	ListOptions
	// Include the account-scope pack; defaults to true.
	IncludeAccount *bool `json:"include_account,omitempty" toon:"include_account,omitempty"`
	// Case-insensitive substring filter over pack ID, scope, scope ID/account ID, and team name.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Restrict to one scope; `all` (default) overrides `include_account`. One of: `all` (account scope plus visible team scopes), `account` (account-level packs only), `team` (team-level packs only, can be combined with `team_ids`).
	Scope string `json:"scope,omitempty" toon:"scope,omitempty"`
	// Restrict to these team IDs; for non-admins the list is intersected with their own teams.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

KnowledgePackListRequest is generated from the Flashduty OpenAPI schema.

type KnowledgePackListResponse added in v0.12.0 

type KnowledgePackListResponse struct {
	// Array of visible knowledge packs after filtering (current page), used with `total` for pagination.
	Packs []KnowledgePackItem `json:"packs" toon:"packs"`
	// Total number of packs after filtering, before pagination.
	Total int64 `json:"total" toon:"total"`
}

KnowledgePackListResponse is generated from the Flashduty OpenAPI schema.

type KnowledgePackUpdateRequest added in v0.12.0 

type KnowledgePackUpdateRequest struct {
	// Knowledge pack ID to update.
	PackID string `json:"pack_id" toon:"pack_id"`
	// Destination scope; omit for a no-op that returns the current pack.
	Scope *string `json:"scope,omitempty" toon:"scope,omitempty"`
	// Destination team ID; required when `scope` is `team`, set automatically for `account`.
	ScopeID *int64 `json:"scope_id,omitempty" toon:"scope_id,omitempty"`
}

KnowledgePackUpdateRequest is generated from the Flashduty OpenAPI schema.

type KnowledgeService added in v0.12.0 

type KnowledgeService service

KnowledgeService handles the "AI SRE/Knowledge" API resource.

func (*KnowledgeService) FileReadGet added in v0.12.0 

func (s *KnowledgeService) FileReadGet(ctx context.Context, req *KnowledgeFileGetRequest) (*KnowledgeFileGetResponse, *Response, error)

Get knowledge file.

Return a knowledge file's metadata and its base64-encoded content.

API: POST /safari/knowledge/file/get (knowledge-file-read-get).

func (*KnowledgeService) FileReadList added in v0.12.0 

func (s *KnowledgeService) FileReadList(ctx context.Context, req *KnowledgeFileListRequest) (*KnowledgeFileListResponse, *Response, error)

List knowledge files.

List the files in a knowledge pack with metadata such as size and checksum.

API: POST /safari/knowledge/file/list (knowledge-file-read-list).

func (*KnowledgeService) FileWriteDelete added in v0.12.0 

func (s *KnowledgeService) FileWriteDelete(ctx context.Context, req *KnowledgeFileDeleteRequest) (*KnowledgeFileDeleteResponse, *Response, error)

Delete knowledge file.

Delete a file from a knowledge pack by its relative path.

API: POST /safari/knowledge/file/delete (knowledge-file-write-delete).

func (*KnowledgeService) FileWritePut added in v0.12.0 

func (s *KnowledgeService) FileWritePut(ctx context.Context, req *KnowledgeFilePutRequest) (*KnowledgeFilePutResponse, *Response, error)

Upload knowledge file.

Create or overwrite a file in a knowledge pack with base64-encoded content.

API: POST /safari/knowledge/file/put (knowledge-file-write-put).

func (*KnowledgeService) PackReadGet added in v0.12.0 

func (s *KnowledgeService) PackReadGet(ctx context.Context) (*KnowledgeGetResponse, *Response, error)

Get account knowledge pack.

Return the account-scope knowledge pack metadata and its file list.

API: POST /safari/knowledge/get (knowledge-pack-read-get).

func (*KnowledgeService) PackReadList added in v0.12.0 

func (s *KnowledgeService) PackReadList(ctx context.Context, req *KnowledgePackListRequest) (*KnowledgePackListResponse, *Response, error)

List knowledge packs.

List knowledge packs visible to the caller across account and team scopes.

API: POST /safari/knowledge/pack/list (knowledge-pack-read-list).

func (*KnowledgeService) PackWriteDelete added in v0.12.0 

func (s *KnowledgeService) PackWriteDelete(ctx context.Context, req *KnowledgePackDeleteRequest) (*KnowledgePackDeleteResponse, *Response, error)

Delete knowledge pack.

Delete a knowledge pack and all of its files.

API: POST /safari/knowledge/pack/delete (knowledge-pack-write-delete).

func (*KnowledgeService) PackWriteEnsure added in v0.12.0 

func (s *KnowledgeService) PackWriteEnsure(ctx context.Context, req *KnowledgePackEnsureRequest) (*KnowledgePackItem, *Response, error)

Ensure knowledge pack.

Idempotently create the knowledge pack at the given scope, or return the existing one.

API: POST /safari/knowledge/pack/ensure (knowledge-pack-write-ensure).

func (*KnowledgeService) PackWriteUpdate added in v0.12.0 

func (s *KnowledgeService) PackWriteUpdate(ctx context.Context, req *KnowledgePackUpdateRequest) (*KnowledgePackItem, *Response, error)

Update knowledge pack.

Move a knowledge pack to a different account or team scope.

API: POST /safari/knowledge/pack/update (knowledge-pack-write-update).

type KnowledgeWarning added in v0.12.0 

type KnowledgeWarning struct {
	// Warning code. One of: `unresolved_reference` (an @ref in the written file's content points to a file that does not exist in the pack; `ref` carries it), `still_referenced_by` (the deleted file is still @ref-referenced by other files in the pack; `refs` lists the referrers).
	Code string `json:"code" toon:"code"`
	// Single reference related to the warning.
	Ref string `json:"ref" toon:"ref"`
	// Multiple references related to the warning.
	Refs []string `json:"refs" toon:"refs"`
}

KnowledgeWarning is generated from the Flashduty OpenAPI schema.

type LicenseListResponse added in v0.5.7 

type LicenseListResponse struct {
	// People holding an active license.
	Items []LicensePersonItem `json:"items" toon:"items"`
	// Number of people holding an active license.
	Total int64 `json:"total" toon:"total"`
}

LicenseListResponse is generated from the Flashduty OpenAPI schema.

type LicensePersonItem added in v0.5.7 

type LicensePersonItem struct {
	// Unix timestamp when a fixed license was assigned. `0` for temporary licenses.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// ID of the licensed person.
	PersonID int64 `json:"person_id" toon:"person_id"`
	// Display name of the licensed person.
	PersonName string `json:"person_name" toon:"person_name"`
	// License assignment type. `fixed` is explicitly assigned; `temporary` is held from the active license window.
	Type string `json:"type" toon:"type"`
	// Unix timestamp when a fixed license was last changed. `0` for temporary licenses.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Person ID that last changed a fixed license. `0` for temporary licenses.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

LicensePersonItem is generated from the Flashduty OpenAPI schema.

type LicensesService added in v0.5.7 

type LicensesService service

LicensesService handles the "On-call/Licenses" API resource.

func (*LicensesService) List added in v0.5.7 

func (s *LicensesService) List(ctx context.Context) (*LicenseListResponse, *Response, error)

List On-call licenses.

List people with active fixed or temporary On-call licenses in the current account.

API: POST /oncall/license/list (oncall-license-read-license-list).

type LinkItem 

type LinkItem struct {
	// Rendered URL for the link.
	Endpoint string `json:"endpoint" toon:"endpoint"`
	// Display name of the link.
	Name string `json:"name" toon:"name"`
	// How the link opens. `popup` opens it in a popup within the incident detail page; `tab` opens it in a new browser tab.
	OpenType string `json:"open_type" toon:"open_type"`
}

LinkItem is generated from the Flashduty OpenAPI schema.

type ListChangeRequest added in v0.4.0 

type ListChangeRequest struct {
	ListOptions
	// Sort in ascending order when true; default is descending.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by channel IDs.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Deprecated: use `integration_ids` instead. Single integration ID to filter by.
	DataSourceID int64 `json:"data_source_id,omitempty" toon:"data_source_id,omitempty"`
	// Deprecated: use `integration_ids` instead. At least 1 entry when provided.
	DataSourceIDs []int64 `json:"data_source_ids,omitempty" toon:"data_source_ids,omitempty"`
	// End of the query window, Unix epoch seconds. See `start_time` for defaults and constraints.
	EndTime int64 `json:"end_time,omitempty" toon:"end_time,omitempty"`
	// Structured filters ANDed onto the query (e.g. on labels). Keys prefixed with `incident` are ignored.
	Filters []FilterCondition `json:"filters,omitempty" toon:"filters,omitempty"`
	// Include the underlying change events for each change when true.
	IncludeEvents bool `json:"include_events,omitempty" toon:"include_events,omitempty"`
	// Deprecated: use `integration_ids` instead. Single integration ID to filter by.
	IntegrationID int64 `json:"integration_id,omitempty" toon:"integration_id,omitempty"`
	// Filter by reporting integration IDs. At least 1 entry when provided.
	IntegrationIDs []int64 `json:"integration_ids,omitempty" toon:"integration_ids,omitempty"`
	// Sort field: `start_time` or `last_time`. Defaults to `start_time`.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Case-insensitive substring or regular-expression match over the change title, change_key, and description. An invalid regular expression falls back to a literal match.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Start of the query window, Unix epoch seconds. Optional — when both `start_time` and `end_time` are omitted or 0, the window defaults to the last hour. Must be less than `end_time`, with a span of at most 31 days. A change matches when its [start_time, last_time] window overlaps the query window.
	StartTime int64 `json:"start_time,omitempty" toon:"start_time,omitempty"`
}

ListChangeRequest is generated from the Flashduty OpenAPI schema.

type ListChangeResponse added in v0.4.0 

type ListChangeResponse struct {
	// Whether more pages are available after this one.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Changes on the current page.
	Items []ChangeItem `json:"items" toon:"items"`
	// Total number of matching changes.
	Total int64 `json:"total" toon:"total"`
}

ListChangeResponse is generated from the Flashduty OpenAPI schema.

type ListChannelsRequest 

type ListChannelsRequest struct {
	ListOptions
	// When true, sort ascending; defaults to false (descending).
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by explicit channel IDs.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Exact-match filter on channel name. Takes priority over `query` for name filtering.
	ChannelName string `json:"channel_name,omitempty" toon:"channel_name,omitempty"`
	// When true, return only `channel_id`, `channel_name`, `description` and `status`, and return all matches without pagination.
	IsBrief bool `json:"is_brief,omitempty" toon:"is_brief,omitempty"`
	// When true, return only channels the caller manages.
	IsMyManaged bool `json:"is_my_managed,omitempty" toon:"is_my_managed,omitempty"`
	// When true, return only channels the caller has starred. Mutually exclusive with `is_my_team`.
	IsMyStarred bool `json:"is_my_starred,omitempty" toon:"is_my_starred,omitempty"`
	// When true, return channels owned by the caller's teams. Mutually exclusive with `is_my_starred`.
	IsMyTeam bool `json:"is_my_team,omitempty" toon:"is_my_team,omitempty"`
	// Field used to order results. Defaults to `created_at`.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Case-insensitive regular expression matched against channel name and description; invalid regex syntax falls back to a literal match.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by team IDs.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

ListChannelsRequest is generated from the Flashduty OpenAPI schema.

type ListChannelsResponse 

type ListChannelsResponse struct {
	// Whether more pages are available.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Channels on the current page.
	Items []ChannelItem `json:"items" toon:"items"`
	// Total matching channels.
	Total int64 `json:"total" toon:"total"`
}

ListChannelsResponse is generated from the Flashduty OpenAPI schema.

type ListDropRulesResponse 

type ListDropRulesResponse struct {
	// All drop (unsubscribe) rules of the channel, excluding deleted ones, ordered by creation time ascending.
	Items []UnsubscribeRuleItem `json:"items" toon:"items"`
}

ListDropRulesResponse is generated from the Flashduty OpenAPI schema.

type ListEscalationRulesResponse 

type ListEscalationRulesResponse struct {
	// All escalation rules of the channel, excluding deleted ones, ordered by priority ascending.
	Items []EscalateRuleItem `json:"items" toon:"items"`
}

ListEscalationRulesResponse is generated from the Flashduty OpenAPI schema.

type ListIncidentAlertsRequest 

type ListIncidentAlertsRequest struct {
	ListOptions
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// When true, include at most the 20 newest raw events in each alert item as a preview.
	IncludeEvents bool `json:"include_events,omitempty" toon:"include_events,omitempty"`
	// When true return only active alerts (Critical/Warning/Info); when false return only recovered alerts (Ok). Omit to include all.
	IsActive *bool `json:"is_active,omitempty" toon:"is_active,omitempty"`
}

ListIncidentAlertsRequest is generated from the Flashduty OpenAPI schema.

type ListIncidentAlertsResponse 

type ListIncidentAlertsResponse struct {
	// Alert list.
	Items []AlertInfo `json:"items" toon:"items"`
	// Total matching alerts.
	Total int64 `json:"total" toon:"total"`
}

ListIncidentAlertsResponse is generated from the Flashduty OpenAPI schema.

type ListIncidentCommentTypesRequest added in v0.8.0 

type ListIncidentCommentTypesRequest struct{}

ListIncidentCommentTypesRequest is generated from the Flashduty OpenAPI schema.

type ListIncidentCommentTypesResponse added in v0.8.0 

type ListIncidentCommentTypesResponse struct {
	// All comment types of the account, ordered by position.
	Items []IncidentCommentTypeItem `json:"items" toon:"items"`
}

ListIncidentCommentTypesResponse is generated from the Flashduty OpenAPI schema.

type ListIncidentFeedRequest 

type ListIncidentFeedRequest struct {
	ListOptions
	// Ascending chronological order when true.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Optional filter restricting the returned entries to specific types.
	Types []IncidentFeedType `json:"types,omitempty" toon:"types,omitempty"`
}

ListIncidentFeedRequest is generated from the Flashduty OpenAPI schema.

type ListIncidentFeedResponse 

type ListIncidentFeedResponse struct {
	// True when more entries are available.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Timeline entries for the current page.
	Items []IncidentFeedItem `json:"items" toon:"items"`
}

ListIncidentFeedResponse is generated from the Flashduty OpenAPI schema.

type ListIncidentsByIDsRequest 

type ListIncidentsByIDsRequest struct {
	// Incident IDs to query; obtain them from `POST /incident/list`.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
}

ListIncidentsByIDsRequest is generated from the Flashduty OpenAPI schema.

type ListIncidentsRequest 

type ListIncidentsRequest struct {
	ListOptions
	// Filter by acker member IDs; obtain member IDs from `POST /member/list`.
	AckerIDs []int64 `json:"acker_ids,omitempty" toon:"acker_ids,omitempty"`
	// Ascending order when true.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Channel IDs to filter by. Use 0 for standalone (global) incidents.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Closer member IDs. Use 0 for automatically closed incidents.
	CloserIDs []int64 `json:"closer_ids,omitempty" toon:"closer_ids,omitempty"`
	// Creator member IDs. Use 0 for automatically created incidents.
	CreatorIDs []int64 `json:"creator_ids,omitempty" toon:"creator_ids,omitempty"`
	// Window end, Unix seconds. Must be greater than `start_time` and within 31 days.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// When true, include only incidents that were ever silenced.
	EverMuted bool `json:"ever_muted,omitempty" toon:"ever_muted,omitempty"`
	// Restrict to the given incident IDs.
	IncidentIDs []string `json:"incident_ids,omitempty" toon:"incident_ids,omitempty"`
	// Comma-separated list of severities (`Critical,Warning,Info`).
	IncidentSeverity string `json:"incident_severity,omitempty" toon:"incident_severity,omitempty"`
	// When true, restrict to incidents in channels the user personally owns.
	IsMyChannel bool `json:"is_my_channel,omitempty" toon:"is_my_channel,omitempty"`
	// When true, restrict to incidents in channels owned by the user's teams.
	IsMyTeam bool `json:"is_my_team,omitempty" toon:"is_my_team,omitempty"`
	// When true, include only outlier (rare) incidents.
	IsRare bool `json:"is_rare,omitempty" toon:"is_rare,omitempty"`
	// When true, include only snoozed incidents.
	IsSnoozed bool `json:"is_snoozed,omitempty" toon:"is_snoozed,omitempty"`
	// Filter by incident short numbers (the numbers shown before incident titles in the console).
	Nums []string `json:"nums,omitempty" toon:"nums,omitempty"`
	// Comma-separated list of progress states to match (e.g. `Triggered,Processing`).
	Progress string `json:"progress,omitempty" toon:"progress,omitempty"`
	// Full-text search query.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by responder member IDs; obtain member IDs from `POST /member/list`.
	ResponderIDs []int64 `json:"responder_ids,omitempty" toon:"responder_ids,omitempty"`
	// Start of the time window (Unix timestamp in seconds). The window with `end_time` may span at most 31 days and filters by incident start time.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Team IDs; resolved to channels via channel ownership.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

ListIncidentsRequest is generated from the Flashduty OpenAPI schema.

type ListInhibitRulesResponse 

type ListInhibitRulesResponse struct {
	// All inhibit rules of the channel, excluding deleted ones, ordered by creation time ascending.
	Items []InhibitRuleItem `json:"items" toon:"items"`
}

ListInhibitRulesResponse is generated from the Flashduty OpenAPI schema.

type ListOptions 

type ListOptions struct {
	// Page is the 1-based page number (wire field "p").
	Page int `json:"p,omitempty"`
	// Limit caps the number of items returned per page.
	Limit int `json:"limit,omitempty"`
	// SearchAfterCtx is the opaque cursor echoed by the previous page for deep
	// pagination; pass it back to fetch the next page.
	SearchAfterCtx string `json:"search_after_ctx,omitempty"`
}

ListOptions holds the pagination inputs shared by every list endpoint. Embed it in a service's request struct; zero values are omitted so they never override the server's defaults (the backend uses p=1, limit=20).

type ListPastIncidentsRequest 

type ListPastIncidentsRequest struct {
	// Reference incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Maximum number of similar incidents to return.
	Limit *int64 `json:"limit,omitempty" toon:"limit,omitempty"`
}

ListPastIncidentsRequest is generated from the Flashduty OpenAPI schema.

type ListPastIncidentsResponse 

type ListPastIncidentsResponse struct {
	// Similar past incidents with similarity scores.
	Items []PastIncidentItem `json:"items" toon:"items"`
}

ListPastIncidentsResponse is generated from the Flashduty OpenAPI schema.

type ListPostMortemTemplatesRequest added in v0.5.4 

type ListPostMortemTemplatesRequest struct {
	ListOptions
	// Ascending order when true.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Field used to order results.
	OrderBy string `json:"order_by,omitempty" toon:"order_by,omitempty"`
}

ListPostMortemTemplatesRequest is generated from the Flashduty OpenAPI schema.

type ListPostMortemTemplatesResponse added in v0.5.4 

type ListPostMortemTemplatesResponse struct {
	// True when another page is available.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Templates in the current page.
	Items []PostMortemTemplate `json:"items" toon:"items"`
	// Cursor for forward pagination.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total matching templates.
	Total int64 `json:"total" toon:"total"`
}

ListPostMortemTemplatesResponse is generated from the Flashduty OpenAPI schema.

type ListPostMortemsRequest 

type ListPostMortemsRequest struct {
	ListOptions
	// Ascending order when true.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Channel IDs to restrict the query to.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Upper bound of post-mortem creation time (Unix timestamp in seconds).
	CreatedAtEndSeconds int64 `json:"created_at_end_seconds,omitempty" toon:"created_at_end_seconds,omitempty"`
	// Lower bound of post-mortem creation time (Unix timestamp in seconds).
	CreatedAtStartSeconds int64 `json:"created_at_start_seconds,omitempty" toon:"created_at_start_seconds,omitempty"`
	// Field used to order results.
	OrderBy string `json:"order_by,omitempty" toon:"order_by,omitempty"`
	// Optional status filter: `drafting` returns only drafts, `published` returns only published post-mortems. When omitted, post-mortems in all statuses are returned.
	Status string `json:"status,omitempty" toon:"status,omitempty"`
	// Team IDs to restrict the query to.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

ListPostMortemsRequest is generated from the Flashduty OpenAPI schema.

type ListPostMortemsResponse 

type ListPostMortemsResponse struct {
	// True when more results are available beyond this page.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Post-mortem metadata for the current page.
	Items []PostMortemMeta `json:"items" toon:"items"`
	// Cursor for forward pagination.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total matching reports.
	Total int64 `json:"total" toon:"total"`
}

ListPostMortemsResponse is generated from the Flashduty OpenAPI schema.

type ListRoutesRequest 

type ListRoutesRequest struct {
	// Integration IDs to fetch routing rules for.
	IntegrationIDs []int64 `json:"integration_ids" toon:"integration_ids"`
}

ListRoutesRequest is generated from the Flashduty OpenAPI schema.

type ListRoutesResponse 

type ListRoutesResponse struct {
	// Routing rules of the requested integrations. Integrations without a configured rule are omitted.
	Items []RouteItem `json:"items" toon:"items"`
}

ListRoutesResponse is generated from the Flashduty OpenAPI schema.

type ListSilenceRulesResponse 

type ListSilenceRulesResponse struct {
	// All silence rules of the channel, excluding deleted ones, ordered by creation time ascending.
	Items []SilenceRuleItem `json:"items" toon:"items"`
}

ListSilenceRulesResponse is generated from the Flashduty OpenAPI schema.

type ListStatusPageResponse added in v0.4.0 

type ListStatusPageResponse struct {
	// Status pages owned by the account.
	Items []StatusPageItem `json:"items" toon:"items"`
}

ListStatusPageResponse is generated from the Flashduty OpenAPI schema.

type ListStatusPageTemplatesResponse added in v0.14.3 

type ListStatusPageTemplatesResponse struct {
	// Templates of the requested category.
	Items []any `json:"items" toon:"items"`
}

ListStatusPageTemplatesResponse is generated from the Flashduty OpenAPI schema.

type ListWarRoomEnabledResponse added in v0.4.0 

type ListWarRoomEnabledResponse struct {
	// IM integrations with the war-room feature enabled.
	Items []WarRoomDataSourceItem `json:"items" toon:"items"`
}

ListWarRoomEnabledResponse is generated from the Flashduty OpenAPI schema.

type ListWarRoomsRequest 

type ListWarRoomsRequest struct {
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Optional filter: only return war rooms for this IM integration.
	IntegrationID int64 `json:"integration_id,omitempty" toon:"integration_id,omitempty"`
}

ListWarRoomsRequest is generated from the Flashduty OpenAPI schema.

type ListWarRoomsResponse 

type ListWarRoomsResponse struct {
	// War room records.
	Items []WarRoomItem `json:"items" toon:"items"`
}

ListWarRoomsResponse is generated from the Flashduty OpenAPI schema.

type ListWebhookHistoryRequest 

type ListWebhookHistoryRequest struct {
	// Ascending order by `event_time` when true; otherwise descending.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Window end time in Unix milliseconds. Must be greater than `start_time`.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// Filter by event type codes (e.g. `i_new` incident created, `a_new` alert triggered).
	EventTypes []string `json:"event_types,omitempty" toon:"event_types,omitempty"`
	// Filter by webhook integration ID.
	IntegrationID int64 `json:"integration_id,omitempty" toon:"integration_id,omitempty"`
	// Page size.
	Limit int64 `json:"limit" toon:"limit"`
	// Sort field. Currently only `event_time` is supported.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Reference ID filter (incident or alert ID).
	RefID string `json:"ref_id,omitempty" toon:"ref_id,omitempty"`
	// Opaque cursor returned by a previous call for fetching the next page.
	SearchAfterCtx string `json:"search_after_ctx,omitempty" toon:"search_after_ctx,omitempty"`
	// Window start time in Unix milliseconds.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Filter by delivery status: `success` or `failed`.
	Status string `json:"status,omitempty" toon:"status,omitempty"`
}

ListWebhookHistoryRequest is generated from the Flashduty OpenAPI schema.

type ListWebhookHistoryResponse 

type ListWebhookHistoryResponse struct {
	// Webhook delivery records on the current page.
	Items []WebhookHistoryItem `json:"items" toon:"items"`
	// Cursor to pass as `search_after_ctx` to fetch the next page. Empty when no further pages are available.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total number of matching records.
	Total int64 `json:"total" toon:"total"`
}

ListWebhookHistoryResponse is generated from the Flashduty OpenAPI schema.

type ListWorkItemRequest added in v0.8.0 

type ListWorkItemRequest struct {
	// Restrict results to items assigned to this member ID. Listing by assignee alone requires being that assignee or an account admin.
	AssigneeID int64 `json:"assignee_id,omitempty" toon:"assignee_id,omitempty"`
	// Pagination cursor from a previous response's `next_cursor`.
	Cursor string `json:"cursor,omitempty" toon:"cursor,omitempty"`
	// Incident ID (MongoDB ObjectID). Also returns follow-ups anchored on the incident's post-mortem.
	IncidentID string `json:"incident_id,omitempty" toon:"incident_id,omitempty"`
	// Filter by work item type: `action` action item, `follow_up` post-mortem follow-up.
	ItemType string `json:"item_type,omitempty" toon:"item_type,omitempty"`
	// Page size, at most 200. Defaults to 50.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
	// Post-mortem ID (32-character hex string). Returns follow-ups bound to this post-mortem.
	PostMortemID string `json:"post_mortem_id,omitempty" toon:"post_mortem_id,omitempty"`
}

ListWorkItemRequest is generated from the Flashduty OpenAPI schema.

type LogPatternDiagnoseSummary added in v0.5.7 

type LogPatternDiagnoseSummary struct {
	// Total aggregated pattern evidence items before the response limit is applied.
	AggregatedPatternEvidenceTotal int64 `json:"aggregated_pattern_evidence_total" toon:"aggregated_pattern_evidence_total"`
	// Log sample summary for the baseline window.
	BaselineSample *LogPatternSampleSummary `json:"baseline_sample,omitempty" toon:"baseline_sample,omitempty"`
	// Log sample summary for the current window.
	CurrentSample LogPatternSampleSummary `json:"current_sample" toon:"current_sample"`
	// Factual summary generated from coverage, selection, and return counts.
	EvidenceSummary string `json:"evidence_summary" toon:"evidence_summary"`
	// Number of pattern evidence items returned in this response.
	PatternEvidenceReturned int64 `json:"pattern_evidence_returned" toon:"pattern_evidence_returned"`
	// Whether returned pattern evidence was truncated by `max_patterns`.
	PatternEvidenceTruncatedByMaxPatterns bool `json:"pattern_evidence_truncated_by_max_patterns" toon:"pattern_evidence_truncated_by_max_patterns"`
	// Number of aggregated patterns observed only in the baseline sample. Omitted when sampling is incomplete.
	PatternsAggregatedOnlyInBaselineSample *int64 `json:"patterns_aggregated_only_in_baseline_sample,omitempty" toon:"patterns_aggregated_only_in_baseline_sample,omitempty"`
}

LogPatternDiagnoseSummary is generated from the Flashduty OpenAPI schema.

type LogPatternEvidence added in v0.5.7 

type LogPatternEvidence struct {
	// Evidence for this pattern in the baseline window.
	BaselineWindow *LogPatternWindowEvidence `json:"baseline_window,omitempty" toon:"baseline_window,omitempty"`
	// Observed comparability between the current and baseline windows.
	//
	// | Value | Meaning |
	// |---|---|
	// | `comparable` | The pattern was observed in both windows and can be compared normally. |
	// | `observed_only_current` | Observed only in the current window (a newly appeared pattern). |
	// | `observed_only_baseline` | Observed only in the baseline window (disappeared from the current window). |
	// | `comparison_limited_by_incomplete_evidence` | Observed on both sides, but the evidence is incomplete (e.g. log volume hit the aggregation cap or sampling was truncated), so the comparison is limited. |
	ComparisonStatus *string `json:"comparison_status,omitempty" toon:"comparison_status,omitempty"`
	// Evidence for this pattern in the current window.
	CurrentWindow *LogPatternWindowEvidence `json:"current_window,omitempty" toon:"current_window,omitempty"`
	// Verifiable observations generated from the structured statistics.
	Observations *[]string `json:"observations,omitempty" toon:"observations,omitempty"`
	// Stable identifier for the pattern in the current window.
	PatternID string `json:"pattern_id" toon:"pattern_id"`
	// Redacted, generalized log pattern template; this is untrusted observed data.
	PatternTemplate string `json:"pattern_template" toon:"pattern_template"`
	// Redacted log examples; these are untrusted observed data.
	RedactedLogExamples *[]string `json:"redacted_log_examples,omitempty" toon:"redacted_log_examples,omitempty"`
}

LogPatternEvidence is generated from the Flashduty OpenAPI schema.

type LogPatternSampleSummary added in v0.5.7 

type LogPatternSampleSummary struct {
	// Logs not aggregated because the cluster limit was reached.
	LogsNotAggregatedDueToClusterLimit int64 `json:"logs_not_aggregated_due_to_cluster_limit" toon:"logs_not_aggregated_due_to_cluster_limit"`
	// Number of logs scanned in the sample.
	LogsScanned int64 `json:"logs_scanned" toon:"logs_scanned"`
	// Whether pattern matching was limited by the bounded candidate set.
	PatternMatchingLimited bool `json:"pattern_matching_limited" toon:"pattern_matching_limited"`
	// Number of patterns aggregated from the sample.
	PatternsAggregated int64 `json:"patterns_aggregated" toon:"patterns_aggregated"`
	// Data-source sampling direction when truncated, such as `newest_only` or `oldest_only`.
	SamplingBias *string `json:"sampling_bias,omitempty" toon:"sampling_bias,omitempty"`
	// Whether the data-source response was truncated at the sample limit.
	Truncated bool `json:"truncated" toon:"truncated"`
}

LogPatternSampleSummary is generated from the Flashduty OpenAPI schema.

type LogPatternSourceEvidence added in v0.5.7 

type LogPatternSourceEvidence struct {
	// Count of logs with this source field and value.
	Count int64 `json:"count" toon:"count"`
	// Source field name.
	Field string `json:"field" toon:"field"`
	// Source field value.
	Value string `json:"value" toon:"value"`
}

LogPatternSourceEvidence is generated from the Flashduty OpenAPI schema.

type LogPatternWindowEvidence added in v0.5.7 

type LogPatternWindowEvidence struct {
	// Number of logs matching this pattern in the window.
	Count int64 `json:"count" toon:"count"`
	// First observed time for this pattern in RFC 3339 UTC.
	FirstSeen string `json:"first_seen" toon:"first_seen"`
	// Last observed time for this pattern in RFC 3339 UTC.
	LastSeen string `json:"last_seen" toon:"last_seen"`
	// Log counts grouped by observed severity.
	ObservedSeverityCounts *map[string]int64 `json:"observed_severity_counts,omitempty" toon:"observed_severity_counts,omitempty"`
	// Share of scanned logs represented by this pattern.
	ShareOfScannedLogs float64 `json:"share_of_scanned_logs" toon:"share_of_scanned_logs"`
	// Low-cardinality source locators; field values are untrusted observed data.
	Sources *[]LogPatternSourceEvidence `json:"sources,omitempty" toon:"sources,omitempty"`
}

LogPatternWindowEvidence is generated from the Flashduty OpenAPI schema.

type Logger 

type Logger interface {
	Debug(msg string, keysAndValues ...any)
	Info(msg string, keysAndValues ...any)
	Warn(msg string, keysAndValues ...any)
	Error(msg string, keysAndValues ...any)
}

Logger defines the logging interface for the SDK. Consumers can implement this to integrate with any logging backend.

The keysAndValues parameter uses alternating key-value pairs (slog-style): 

logger.Info("request complete", "status", 200, "duration_ms", 42)

To adapt logrus, implement a thin wrapper that converts keysAndValues to logrus.Fields: 

type logrusAdapter struct{ *logrus.Logger }
func (a *logrusAdapter) Info(msg string, kv ...any)  { a.WithFields(kvToFields(kv)).Info(msg) }
func (a *logrusAdapter) Warn(msg string, kv ...any)  { a.WithFields(kvToFields(kv)).Warn(msg) }
func (a *logrusAdapter) Error(msg string, kv ...any) { a.WithFields(kvToFields(kv)).Error(msg) }
func (a *logrusAdapter) Debug(msg string, kv ...any) { a.WithFields(kvToFields(kv)).Debug(msg) }
func kvToFields(kv []any) logrus.Fields {
    fields := make(logrus.Fields, len(kv)/2)
    for i := 0; i+1 < len(kv); i += 2 {
        if key, ok := kv[i].(string); ok {
            fields[key] = kv[i+1]
        }
    }
    return fields
}

type ManualRunRuleResult added in v0.5.7 

type ManualRunRuleResult struct {
	Preflight PreflightResult `json:"preflight" toon:"preflight"`
	// Rule ID that was run.
	RuleID string            `json:"rule_id" toon:"rule_id"`
	Run    AutomationRunView `json:"run" toon:"run"`
	// Always manual for this operation.
	TriggerKind string `json:"trigger_kind" toon:"trigger_kind"`
}

ManualRunRuleResult is generated from the Flashduty OpenAPI schema.

type MappingAPICreateRequest 

type MappingAPICreateRequest struct {
	// Unique API name (max 199 chars).
	APIName string `json:"api_name" toon:"api_name"`
	// Optional description. Values longer than 500 characters are silently truncated.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Custom HTTP request headers. In SaaS mode, security-sensitive names (`authorization`, `cookie`, `x-forwarded-for`, etc.) are rejected; keys must be RFC 7230 token characters (max 1024 chars) and values max 4096 chars.
	Headers map[string]string `json:"headers,omitempty" toon:"headers,omitempty"`
	// Skip TLS certificate verification. Default `false`.
	InsecureSkipVerify bool `json:"insecure_skip_verify,omitempty" toon:"insecure_skip_verify,omitempty"`
	// Number of retries on failure (0–1). Default 0.
	RetryCount int64 `json:"retry_count,omitempty" toon:"retry_count,omitempty"`
	// Owning team ID; obtain it from `POST /team/list`.
	TeamID int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Request timeout in seconds (1–3). Default 2.
	Timeout int64 `json:"timeout,omitempty" toon:"timeout,omitempty"`
	// HTTP/HTTPS endpoint URL (max 500 chars).
	URL string `json:"url" toon:"url"`
}

MappingAPICreateRequest is generated from the Flashduty OpenAPI schema.

type MappingAPICreateResponse 

type MappingAPICreateResponse struct {
	// Created API ID (MongoDB ObjectID hex).
	APIID string `json:"api_id" toon:"api_id"`
	// API name.
	APIName string `json:"api_name" toon:"api_name"`
}

MappingAPICreateResponse is generated from the Flashduty OpenAPI schema.

type MappingAPIItem 

type MappingAPIItem struct {
	// API ID (MongoDB ObjectID hex).
	APIID string `json:"api_id" toon:"api_id"`
	// API name.
	APIName string `json:"api_name" toon:"api_name"`
	// Creation time, Unix seconds. Omitted when 0 (legacy records).
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Creator member ID.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Deletion time, Unix seconds. Omitted when the API has not been soft-deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Description.
	Description string `json:"description" toon:"description"`
	// Custom request headers. `null` when none are configured.
	Headers map[string]string `json:"headers" toon:"headers"`
	// Whether TLS verification is skipped.
	InsecureSkipVerify bool `json:"insecure_skip_verify" toon:"insecure_skip_verify"`
	// Retry count.
	RetryCount int64 `json:"retry_count" toon:"retry_count"`
	// API status: `enabled` or `deleted` (soft-deleted). The list endpoint excludes `deleted` items; the info endpoint may return them.
	Status string `json:"status" toon:"status"`
	// Owning team ID.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Request timeout in seconds.
	Timeout int64 `json:"timeout" toon:"timeout"`
	// Last update time, Unix seconds. Omitted when 0 (legacy records).
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Last updater member ID.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
	// Endpoint URL.
	URL string `json:"url" toon:"url"`
}

MappingAPIItem is generated from the Flashduty OpenAPI schema.

type MappingAPIListResponse 

type MappingAPIListResponse struct {
	// Mapping APIs.
	Items []MappingAPIItem `json:"items" toon:"items"`
	// Total API count.
	Total int64 `json:"total" toon:"total"`
}

MappingAPIListResponse is generated from the Flashduty OpenAPI schema.

type MappingAPIUpdateRequest 

type MappingAPIUpdateRequest struct {
	// Mapping API ID (MongoDB ObjectID hex).
	APIID string `json:"api_id" toon:"api_id"`
	// New API name (max 199 chars).
	APIName *string `json:"api_name,omitempty" toon:"api_name,omitempty"`
	// New description.
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// Custom HTTP request headers. In SaaS mode, security-sensitive names (`authorization`, `cookie`, `x-forwarded-for`, etc.) are rejected; keys must be RFC 7230 token characters (max 1024 chars) and values max 4096 chars.
	Headers map[string]string `json:"headers,omitempty" toon:"headers,omitempty"`
	// New TLS skip-verify setting.
	InsecureSkipVerify *bool `json:"insecure_skip_verify,omitempty" toon:"insecure_skip_verify,omitempty"`
	// New retry count.
	RetryCount *int64 `json:"retry_count,omitempty" toon:"retry_count,omitempty"`
	// New owning team ID; obtain it from `POST /team/list`.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// New timeout in seconds.
	Timeout *int64 `json:"timeout,omitempty" toon:"timeout,omitempty"`
	// New endpoint URL (max 500 chars).
	URL *string `json:"url,omitempty" toon:"url,omitempty"`
}

MappingAPIUpdateRequest is generated from the Flashduty OpenAPI schema.

type MappingApiidRequest 

type MappingApiidRequest struct {
	// Mapping API ID (MongoDB ObjectID hex).
	APIID string `json:"api_id" toon:"api_id"`
}

MappingApiidRequest is generated from the Flashduty OpenAPI schema.

type MappingDataDeleteRequest 

type MappingDataDeleteRequest struct {
	// Keys of rows to delete.
	Keys []string `json:"keys" toon:"keys"`
	// Mapping schema ID (MongoDB ObjectID hex).
	SchemaID string `json:"schema_id" toon:"schema_id"`
}

MappingDataDeleteRequest is generated from the Flashduty OpenAPI schema.

type MappingDataItem 

type MappingDataItem struct {
	// Creation time, Unix seconds. Omitted when 0.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// All label key-value pairs of this row. Omitted when empty.
	Fields map[string]string `json:"fields" toon:"fields"`
	// Composite row key — MD5 of the row's source label values (sorted by label name, joined with `:`). Omitted when empty.
	Key string `json:"key" toon:"key"`
	// Last update time, Unix seconds. Omitted when 0.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

MappingDataItem is generated from the Flashduty OpenAPI schema.

type MappingDataListRequest 

type MappingDataListRequest struct {
	ListOptions
	// Sort ascending when `true`.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Sort field. Defaults to `updated_at`.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Exact-match filter on source label values. Keys that are not source labels of the schema are silently ignored; if any source label is given, all source labels must be provided.
	Query map[string]string `json:"query,omitempty" toon:"query,omitempty"`
	// Mapping schema ID (MongoDB ObjectID hex).
	SchemaID string `json:"schema_id" toon:"schema_id"`
}

MappingDataListRequest is generated from the Flashduty OpenAPI schema.

type MappingDataListResponse 

type MappingDataListResponse struct {
	// Whether more pages exist.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Data rows.
	Items []MappingDataItem `json:"items" toon:"items"`
	// Cursor token (ObjectID hex of this page's last row) for fetching the next page. Omitted when there is no next page.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total matching rows.
	Total int64 `json:"total" toon:"total"`
}

MappingDataListResponse is generated from the Flashduty OpenAPI schema.

type MappingDataUploadRequest 

type MappingDataUploadRequest struct {
	// SchemaID is the ID of the target mapping schema (ObjectID hex). Required.
	SchemaID string
	// DoNotTruncateFirst appends the CSV rows to the existing data instead of
	// truncating it first.
	DoNotTruncateFirst bool
	// File is the CSV content. Required. Max 100 MB; the header row must
	// include all of the schema's source/result label names.
	File io.Reader
	// Filename is the multipart file name; defaults to "mapping.csv".
	Filename string
}

MappingDataUploadRequest carries the CSV file and options for MappingDataWriteUpload. It is hand-written rather than generated because the endpoint consumes multipart/form-data, which the generated JSON request path cannot encode.

type MappingDataUpsertRequest 

type MappingDataUpsertRequest struct {
	// Rows to insert or update. Each row must include all source and result labels; unknown labels are silently dropped; a value longer than 2048 characters is rejected.
	Docs []map[string]string `json:"docs" toon:"docs"`
	// Mapping schema ID (MongoDB ObjectID hex).
	SchemaID string `json:"schema_id" toon:"schema_id"`
}

MappingDataUpsertRequest is generated from the Flashduty OpenAPI schema.

type MappingDataUpsertResponse 

type MappingDataUpsertResponse struct {
	// Composite keys of upserted rows.
	Keys []string `json:"keys" toon:"keys"`
}

MappingDataUpsertResponse is generated from the Flashduty OpenAPI schema.

type MappingSchemaCreateRequest 

type MappingSchemaCreateRequest struct {
	// Optional description (max 500 chars).
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Output label names written on a match (1–10). Each must match `^[a-zA-Z_][a-zA-Z0-9_]*$`; entries must be unique and must not overlap with `source_labels`.
	ResultLabels []string `json:"result_labels" toon:"result_labels"`
	// Unique schema name (max 39 chars).
	SchemaName string `json:"schema_name" toon:"schema_name"`
	// Lookup key label names (1–3). Each must match `^[a-zA-Z_][a-zA-Z0-9_]*$`; entries must be unique and must not overlap with `result_labels`.
	SourceLabels []string `json:"source_labels" toon:"source_labels"`
	// Owning team ID. `0` means no team.
	TeamID int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
}

MappingSchemaCreateRequest is generated from the Flashduty OpenAPI schema.

type MappingSchemaCreateResponse 

type MappingSchemaCreateResponse struct {
	// Created schema ID (MongoDB ObjectID hex).
	SchemaID string `json:"schema_id" toon:"schema_id"`
	// Schema name.
	SchemaName string `json:"schema_name" toon:"schema_name"`
}

MappingSchemaCreateResponse is generated from the Flashduty OpenAPI schema.

type MappingSchemaIDRequest 

type MappingSchemaIDRequest struct {
	// Mapping schema ID (MongoDB ObjectID hex).
	SchemaID string `json:"schema_id" toon:"schema_id"`
}

MappingSchemaIDRequest is generated from the Flashduty OpenAPI schema.

type MappingSchemaItem 

type MappingSchemaItem struct {
	// Creation time, Unix seconds. Omitted when 0 (legacy records).
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Creator member ID.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Deletion time, Unix seconds. Omitted when the schema has not been soft-deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Schema description.
	Description string `json:"description" toon:"description"`
	// Output label names.
	ResultLabels []string `json:"result_labels" toon:"result_labels"`
	// Schema ID (MongoDB ObjectID hex).
	SchemaID string `json:"schema_id" toon:"schema_id"`
	// Schema name.
	SchemaName string `json:"schema_name" toon:"schema_name"`
	// Lookup key label names.
	SourceLabels []string `json:"source_labels" toon:"source_labels"`
	// Schema status: `enabled` or `deleted` (soft-deleted). The list endpoint excludes `deleted` items; the info endpoint may return them.
	Status string `json:"status" toon:"status"`
	// Owning team ID.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Last update time, Unix seconds. Omitted when 0 (legacy records).
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Last updater member ID.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

MappingSchemaItem is generated from the Flashduty OpenAPI schema.

type MappingSchemaListResponse 

type MappingSchemaListResponse struct {
	// Mapping schemas.
	Items []MappingSchemaItem `json:"items" toon:"items"`
	// Total schema count.
	Total int64 `json:"total" toon:"total"`
}

MappingSchemaListResponse is generated from the Flashduty OpenAPI schema.

type MappingSchemaUpdateRequest 

type MappingSchemaUpdateRequest struct {
	// New description (max 500 chars).
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// Schema ID (MongoDB ObjectID hex).
	SchemaID string `json:"schema_id" toon:"schema_id"`
	// New schema name (max 39 chars).
	SchemaName *string `json:"schema_name,omitempty" toon:"schema_name,omitempty"`
	// New owning team ID. `0` removes the team association.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
}

MappingSchemaUpdateRequest is generated from the Flashduty OpenAPI schema.

type McpServerCreateRequest added in v0.4.0 

type McpServerCreateRequest struct {
	// Allow this server's OAuth token exchange over plaintext HTTP. Testing use only; defaults to false.
	AllowInsecureOauthHTTP bool `json:"allow_insecure_oauth_http,omitempty" toon:"allow_insecure_oauth_http,omitempty"`
	// Skip TLS certificate verification when connecting to this server. Testing use only; defaults to false.
	AllowInsecureTlsSkipVerify bool `json:"allow_insecure_tls_skip_verify,omitempty" toon:"allow_insecure_tls_skip_verify,omitempty"`
	// Command arguments (stdio transport).
	Args []string `json:"args,omitempty" toon:"args,omitempty"`
	// Authentication mode: shared (default), per_user_secret, or per_user_oauth.
	AuthMode string `json:"auth_mode,omitempty" toon:"auth_mode,omitempty"`
	// Tool-call timeout in seconds. 0 = default (60s).
	CallTimeout int64 `json:"call_timeout,omitempty" toon:"call_timeout,omitempty"`
	// Executable command (stdio transport).
	Command string `json:"command,omitempty" toon:"command,omitempty"`
	// Connection timeout in seconds. 0 = default (10s).
	ConnectTimeout int64 `json:"connect_timeout,omitempty" toon:"connect_timeout,omitempty"`
	// Server description.
	Description string `json:"description" toon:"description"`
	// Environment variables (stdio transport).
	Env map[string]string `json:"env,omitempty" toon:"env,omitempty"`
	// Execution environments this server is callable from: `cloud` and/or BYOC runner environment IDs. Omitted or empty means all environments.
	Environments []string `json:"environments,omitempty" toon:"environments,omitempty"`
	// HTTP headers (sse / streamable-http).
	Headers map[string]string `json:"headers,omitempty" toon:"headers,omitempty"`
	// JSON OAuth metadata; reserved for per_user_oauth.
	OauthMetadata string `json:"oauth_metadata,omitempty" toon:"oauth_metadata,omitempty"`
	// JSON secret schema; required when auth_mode=per_user_secret.
	SecretSchema string `json:"secret_schema,omitempty" toon:"secret_schema,omitempty"`
	// MCP server name: must start with a letter and contain only letters, digits, `-`, or `_` (`@` is reserved); unique within its scope (account-wide or one team), case-insensitive.
	ServerName string `json:"server_name" toon:"server_name"`
	// Marketplace template name when created from a connector template.
	SourceTemplateName string `json:"source_template_name,omitempty" toon:"source_template_name,omitempty"`
	// Initial status: `enabled` (default) or `disabled` (created but kept off).
	Status string `json:"status,omitempty" toon:"status,omitempty"`
	// Team scope: 0 = account-wide; >0 = team.
	TeamID int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Transport protocol: `stdio` launches a local process via `command`/`args`/`env`, `sse` / `streamable-http` connects to a remote service via `url`/`headers`.
	Transport string `json:"transport" toon:"transport"`
	// Server URL (sse / streamable-http transport).
	URL string `json:"url,omitempty" toon:"url,omitempty"`
}

McpServerCreateRequest is generated from the Flashduty OpenAPI schema.

type McpServerDeleteRequest added in v0.4.0 

type McpServerDeleteRequest struct {
	// Target MCP server ID, from the list returned by `POST /safari/mcp/server/list`.
	ServerID string `json:"server_id" toon:"server_id"`
}

McpServerDeleteRequest is generated from the Flashduty OpenAPI schema.

type McpServerGetRequest added in v0.4.0 

type McpServerGetRequest struct {
	// Target MCP server ID, from the list returned by `POST /safari/mcp/server/list`.
	ServerID string `json:"server_id" toon:"server_id"`
}

McpServerGetRequest is generated from the Flashduty OpenAPI schema.

type McpServerItem added in v0.4.0 

type McpServerItem struct {
	// Owning account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// LLM-generated description, preferred over `description` when present. Omitted when not yet generated.
	AIDescription string `json:"ai_description" toon:"ai_description"`
	// Allow this server's OAuth token exchange over plaintext HTTP; testing use only. Omitted when false.
	AllowInsecureOauthHTTP bool `json:"allow_insecure_oauth_http" toon:"allow_insecure_oauth_http"`
	// Skip TLS certificate verification when connecting to this server; testing use only. Omitted when false.
	AllowInsecureTlsSkipVerify bool `json:"allow_insecure_tls_skip_verify" toon:"allow_insecure_tls_skip_verify"`
	// Command arguments (stdio transport).
	Args []string `json:"args" toon:"args"`
	// Authentication mode. One of: `shared` (a single static credential saved on the resource and shared by all callers in the account; the default — an empty value behaves the same), `per_user_secret` (each user stores their own secret per `secret_schema`, injected per user at runtime), `per_user_oauth` (each user completes their own OAuth grant; discovery and registration run lazily on first use).
	AuthMode string `json:"auth_mode" toon:"auth_mode"`
	// Tool-call timeout in seconds (0 = server default, 60s).
	CallTimeout int64 `json:"call_timeout" toon:"call_timeout"`
	// Whether the caller may edit this server.
	CanEdit bool `json:"can_edit" toon:"can_edit"`
	// Executable command (stdio transport only).
	Command string `json:"command" toon:"command"`
	// Connection timeout in seconds (0 = server default, 10s).
	ConnectTimeout int64 `json:"connect_timeout" toon:"connect_timeout"`
	// Creation time. Unix timestamp in milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Member ID that created the server.
	CreatedBy int64 `json:"created_by" toon:"created_by"`
	// Server description.
	Description string `json:"description" toon:"description"`
	// Environment variables (stdio transport). Secret values are masked.
	Env map[string]string `json:"env" toon:"env"`
	// Execution environments this server is callable from (`cloud` and/or BYOC runner environment IDs). Always present; `[]` means all environments (also the value on legacy rows created before this field).
	Environments []string `json:"environments" toon:"environments"`
	// HTTP headers (sse / streamable-http). Secret values are masked.
	Headers map[string]string `json:"headers" toon:"headers"`
	// JSON-encoded OAuth metadata (per_user_oauth mode).
	OauthMetadata string `json:"oauth_metadata" toon:"oauth_metadata"`
	// Outbound proxy URL used to reach the server.
	ProxyURL string `json:"proxy_url" toon:"proxy_url"`
	// JSON-encoded secret schema (per_user_secret mode).
	SecretSchema string `json:"secret_schema" toon:"secret_schema"`
	// Unique MCP server ID (prefix `mcp_`).
	ServerID string `json:"server_id" toon:"server_id"`
	// MCP server name, unique within its scope (account-wide or one team), case-insensitive.
	ServerName string `json:"server_name" toon:"server_name"`
	// Marketplace template this connector was installed from; empty for user-authored.
	SourceTemplateName string `json:"source_template_name" toon:"source_template_name"`
	// Server status.
	Status string `json:"status" toon:"status"`
	// Team scope: 0 = account-wide; >0 = the owning team.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Transport protocol. One of: `stdio` (standard I/O to a local subprocess), `sse` (standalone SSE, the legacy MCP transport), `streamable-http` (the newer HTTP streaming transport).
	Transport string `json:"transport" toon:"transport"`
	// Last update time. Unix timestamp in milliseconds.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
	// Server URL (sse / streamable-http transport).
	URL string `json:"url" toon:"url"`
}

McpServerItem is generated from the Flashduty OpenAPI schema.

type McpServerListRequest added in v0.4.0 

type McpServerListRequest struct {
	ListOptions
	// Include account-scoped (team_id=0) rows. Defaults to true.
	IncludeAccount *bool `json:"include_account,omitempty" toon:"include_account,omitempty"`
	// Case-insensitive substring search across name, description, AI-generated description, server ID, transport, URL, command, and source template name.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Restrict results to a scope: `account` for account-wide rows only, `team` for the caller's own visible team rows only, or omit (defaults to `all`) for both, subject to team_ids/include_account.
	Scope string `json:"scope,omitempty" toon:"scope,omitempty"`
	// Filter to these team IDs; empty = the caller's visible set.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

McpServerListRequest is generated from the Flashduty OpenAPI schema.

type McpServerListResponse added in v0.4.0 

type McpServerListResponse struct {
	// MCP servers on this page.
	Servers []McpServerItem `json:"servers" toon:"servers"`
	// Total number of matching servers.
	Total int64 `json:"total" toon:"total"`
}

McpServerListResponse is generated from the Flashduty OpenAPI schema.

type McpServerStatusRequest added in v0.4.0 

type McpServerStatusRequest struct {
	// Target MCP server ID, from the list returned by `POST /safari/mcp/server/list`.
	ServerID string `json:"server_id" toon:"server_id"`
}

McpServerStatusRequest is generated from the Flashduty OpenAPI schema.

type McpServerUpdateRequest added in v0.4.0 

type McpServerUpdateRequest struct {
	// Allow OAuth token exchange over plaintext HTTP. Omit to leave unchanged.
	AllowInsecureOauthHTTP *bool `json:"allow_insecure_oauth_http,omitempty" toon:"allow_insecure_oauth_http,omitempty"`
	// Skip TLS certificate verification. Omit to leave unchanged.
	AllowInsecureTlsSkipVerify *bool `json:"allow_insecure_tls_skip_verify,omitempty" toon:"allow_insecure_tls_skip_verify,omitempty"`
	// Command arguments (`stdio` transport); replaces the whole list — pass `[]` to clear, omit to leave unchanged.
	Args []string `json:"args,omitempty" toon:"args,omitempty"`
	// Authentication mode: shared (default), per_user_secret, or per_user_oauth.
	AuthMode string `json:"auth_mode,omitempty" toon:"auth_mode,omitempty"`
	// Tool-call timeout in seconds. 0 = default (60s).
	CallTimeout int64 `json:"call_timeout,omitempty" toon:"call_timeout,omitempty"`
	// Executable command (stdio transport).
	Command string `json:"command,omitempty" toon:"command,omitempty"`
	// Connection timeout in seconds. 0 = default (10s).
	ConnectTimeout int64 `json:"connect_timeout,omitempty" toon:"connect_timeout,omitempty"`
	// New description; omitted or empty leaves it unchanged.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Environment variables (`stdio` transport); replaces the whole map, but a sensitive key sent back masked or as an empty string keeps its stored value; omit to leave unchanged.
	Env map[string]string `json:"env,omitempty" toon:"env,omitempty"`
	// Execution environments this server is callable from: `cloud` and/or BYOC runner environment IDs. Omit (null) to leave unchanged; send a list to set it — an empty list clears the restriction back to all environments.
	Environments []string `json:"environments,omitempty" toon:"environments,omitempty"`
	// HTTP headers (`sse` / `streamable-http` transport); replaces the whole map, with the same masked/empty-value preservation as `env`; omit to leave unchanged.
	Headers map[string]string `json:"headers,omitempty" toon:"headers,omitempty"`
	// JSON OAuth metadata; reserved for per_user_oauth.
	OauthMetadata string `json:"oauth_metadata,omitempty" toon:"oauth_metadata,omitempty"`
	// JSON secret schema; required when auth_mode=per_user_secret.
	SecretSchema string `json:"secret_schema,omitempty" toon:"secret_schema,omitempty"`
	// Target MCP server ID, from the list returned by `POST /safari/mcp/server/list`.
	ServerID string `json:"server_id" toon:"server_id"`
	// New name; omitted or empty leaves it unchanged.
	ServerName string `json:"server_name,omitempty" toon:"server_name,omitempty"`
	// Reassign team scope: 0 = account-wide; >0 = team. Omit to leave unchanged.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Transport protocol; when switching, also supply the matching fields (`command`/`args`/`env` for `stdio`, `url`/`headers` for `sse` / `streamable-http`); omitted or empty leaves it unchanged.
	Transport string `json:"transport,omitempty" toon:"transport,omitempty"`
	// Server URL (sse / streamable-http transport).
	URL string `json:"url,omitempty" toon:"url,omitempty"`
}

McpServerUpdateRequest is generated from the Flashduty OpenAPI schema.

type McpServersService added in v0.4.0 

type McpServersService service

McpServersService handles the "AI SRE/MCP servers" API resource.

func (*McpServersService) ReadServerGet added in v0.4.0 

func (s *McpServersService) ReadServerGet(ctx context.Context, req *McpServerGetRequest) (*McpServerItem, *Response, error)

Get MCP server detail.

Get one MCP server as a pure database read — no live probe is performed.

API: POST /safari/mcp/server/get (mcp-read-server-get).

func (*McpServersService) ReadServerList added in v0.4.0 

func (s *McpServersService) ReadServerList(ctx context.Context, req *McpServerListRequest) (*McpServerListResponse, *Response, error)

List MCP servers.

List MCP servers visible to the caller across account and team scopes, with pagination.

API: POST /safari/mcp/server/list (mcp-read-server-list).

func (*McpServersService) WriteServerCreate added in v0.4.0 

func (s *McpServersService) WriteServerCreate(ctx context.Context, req *McpServerCreateRequest) (*McpServerItem, *Response, error)

Create MCP server.

Register a new MCP server (connector) on the account.

API: POST /safari/mcp/server/create (mcp-write-server-create).

func (*McpServersService) WriteServerDelete added in v0.4.0 

func (s *McpServersService) WriteServerDelete(ctx context.Context, req *McpServerDeleteRequest) (*any, *Response, error)

Delete MCP server.

Delete an MCP server by ID.

API: POST /safari/mcp/server/delete (mcp-write-server-delete).

func (*McpServersService) WriteServerDisable added in v0.4.0 

func (s *McpServersService) WriteServerDisable(ctx context.Context, req *McpServerStatusRequest) (*any, *Response, error)

Disable MCP server.

Disable an enabled MCP server.

API: POST /safari/mcp/server/disable (mcp-write-server-disable).

func (*McpServersService) WriteServerEnable added in v0.4.0 

func (s *McpServersService) WriteServerEnable(ctx context.Context, req *McpServerStatusRequest) (*any, *Response, error)

Enable MCP server.

Enable a disabled MCP server.

API: POST /safari/mcp/server/enable (mcp-write-server-enable).

func (*McpServersService) WriteServerUpdate added in v0.4.0 

func (s *McpServersService) WriteServerUpdate(ctx context.Context, req *McpServerUpdateRequest) (*McpServerItem, *Response, error)

Update MCP server.

Update an MCP server's configuration. Omit a field to leave it unchanged.

API: POST /safari/mcp/server/update (mcp-write-server-update).

type MemberDeleteRequest 

type MemberDeleteRequest struct {
	// Region hint for parsing `phone` when it has no "+" prefix — an ISO 3166-1 alpha-2 code such as "CN" (the default when omitted). Legacy digit calling codes like "86" are still accepted in this parsing context.
	CountryCode string `json:"country_code,omitempty" toon:"country_code,omitempty"`
	// Email address. Only used when neither `member_id` nor `member_name` is provided
	Email string `json:"email,omitempty" toon:"email,omitempty"`
	// Force delete. Defaults to false, which checks for references from escalation rules, schedules, etc. Set to true to skip the reference check and delete immediately
	IsForce bool `json:"is_force,omitempty" toon:"is_force,omitempty"`
	// Member ID. When several lookup fields are provided, the first non-empty one wins in the order `member_id` > `member_name` > `email` > `phone` > `ref_id`
	MemberID uint64 `json:"member_id,omitempty" toon:"member_id,omitempty"`
	// Member name. Only used when `member_id` is not provided
	MemberName string `json:"member_name,omitempty" toon:"member_name,omitempty"`
	// Phone number. Only used when `member_id`, `member_name`, and `email` are all absent
	Phone string `json:"phone,omitempty" toon:"phone,omitempty"`
	// External reference ID. Only used when all other lookup fields are absent
	RefID string `json:"ref_id,omitempty" toon:"ref_id,omitempty"`
}

MemberDeleteRequest is generated from the Flashduty OpenAPI schema.

type MemberEmptyObject 

type MemberEmptyObject struct{}

MemberEmptyObject is generated from the Flashduty OpenAPI schema.

type MemberInfoRequest 

type MemberInfoRequest struct{}

MemberInfoRequest is generated from the Flashduty OpenAPI schema.

type MemberInfoResponse 

type MemberInfoResponse struct {
	// Account avatar URL
	AccountAvatar string `json:"account_avatar" toon:"account_avatar"`
	// Account email
	AccountEmail string `json:"account_email" toon:"account_email"`
	// Account ID
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Account-level locale preference (e.g. zh-CN or en-US). Omitted when the account has none set.
	AccountLocale string `json:"account_locale" toon:"account_locale"`
	// Account name
	AccountName string `json:"account_name" toon:"account_name"`
	// Assigned role IDs
	AccountRoleIDs []uint64 `json:"account_role_ids" toon:"account_role_ids"`
	// Account-level time zone (e.g. Asia/Shanghai). Omitted when the account has none set.
	AccountTimeZone string `json:"account_time_zone" toon:"account_time_zone"`
	// Member avatar URL
	Avatar string `json:"avatar" toon:"avatar"`
	// ISO 3166-1 alpha-2 region code of the member's contact phone (e.g. "CN", "US", "HK").
	CountryCode string `json:"country_code" toon:"country_code"`
	// Member creation time, Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Account domain
	Domain string `json:"domain" toon:"domain"`
	// Email address
	Email string `json:"email" toon:"email"`
	// Whether email is verified
	EmailVerified bool `json:"email_verified" toon:"email_verified"`
	// Whether provisioned via SSO
	IsExternal bool `json:"is_external" toon:"is_external"`
	// Member's locale preference. Omitted when the member has none set.
	Locale string `json:"locale" toon:"locale"`
	// Member ID
	MemberID uint64 `json:"member_id" toon:"member_id"`
	// Member display name
	MemberName string `json:"member_name" toon:"member_name"`
	// Account identifier on the marketplace platform. Omitted together with `mp_plat`.
	MpAccountID string `json:"mp_account_id" toon:"mp_account_id"`
	// Cloud marketplace platform the account was provisioned from. Omitted when the account did not come from a marketplace.
	MpPlat string `json:"mp_plat" toon:"mp_plat"`
	// Masked phone number
	Phone string `json:"phone" toon:"phone"`
	// Whether phone is verified
	PhoneVerified bool `json:"phone_verified" toon:"phone_verified"`
	// Member's IANA time zone. Omitted when the member has none set.
	TimeZone string `json:"time_zone" toon:"time_zone"`
}

MemberInfoResponse is generated from the Flashduty OpenAPI schema.

type MemberInviteRequest 

type MemberInviteRequest struct {
	// Invite source. Only takes effect when the account has member invites disabled and the value is `api`: members are created directly in the enabled state with email/phone marked verified and no invitation sent. Any other value follows the normal invite flow
	From string `json:"from,omitempty" toon:"from,omitempty"`
	// Members to invite in one call (at least 1). Each entry needs either an `email`, or `member_name` + `phone` together.
	Members []InviteMemberItem `json:"members" toon:"members"`
}

MemberInviteRequest is generated from the Flashduty OpenAPI schema.

type MemberInviteResponse 

type MemberInviteResponse struct {
	// Newly created members
	Items []NewMemberItem `json:"items" toon:"items"`
}

MemberInviteResponse is generated from the Flashduty OpenAPI schema.

type MemberItem 

type MemberItem struct {
	// Account ID
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Role IDs
	AccountRoleIDs []uint64 `json:"account_role_ids" toon:"account_role_ids"`
	// Avatar URL
	Avatar string `json:"avatar" toon:"avatar"`
	// ISO 3166-1 alpha-2 region code of the member's contact phone (e.g. "CN", "US", "HK").
	CountryCode string `json:"country_code" toon:"country_code"`
	// Creation timestamp (Unix seconds)
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Email address
	Email string `json:"email" toon:"email"`
	// Email verified
	EmailVerified bool `json:"email_verified" toon:"email_verified"`
	// Provisioned via SSO
	IsExternal bool `json:"is_external" toon:"is_external"`
	// Member's locale preference (e.g. `zh-CN`). Omitted when empty — the list endpoint does not populate it.
	Locale string `json:"locale" toon:"locale"`
	// Member ID
	MemberID uint64 `json:"member_id" toon:"member_id"`
	// Display name
	MemberName string `json:"member_name" toon:"member_name"`
	// Masked phone number
	Phone string `json:"phone" toon:"phone"`
	// Phone verified
	PhoneVerified bool `json:"phone_verified" toon:"phone_verified"`
	// External reference ID
	RefID string `json:"ref_id" toon:"ref_id"`
	// Member status. `enabled` — active member; `pending` — invited but not yet accepted; `deleted` — removed from the organization.
	Status string `json:"status" toon:"status"`
	// Member's IANA time zone (e.g. `Asia/Shanghai`). Omitted when empty — the list endpoint does not populate it.
	TimeZone string `json:"time_zone" toon:"time_zone"`
	// Update timestamp (Unix seconds)
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

MemberItem is generated from the Flashduty OpenAPI schema.

type MemberListRequest 

type MemberListRequest struct {
	ListOptions
	// Ascending order. Default: false (descending)
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Sort field. Default: `updated_at`
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Substring match on member name or email; if the keyword parses as a phone number, an exact phone match is also applied
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by role ID. Get role IDs from `POST /role/list` (built-in roles: 2=Admin, 6=Responder, 8=Viewer)
	RoleID uint64 `json:"role_id,omitempty" toon:"role_id,omitempty"`
}

MemberListRequest is generated from the Flashduty OpenAPI schema.

type MemberListResponse 

type MemberListResponse struct {
	ListOptions
	// Member items
	Items []MemberItem `json:"items" toon:"items"`
	// Total count
	Total int64 `json:"total" toon:"total"`
}

MemberListResponse is generated from the Flashduty OpenAPI schema.

type MemberResetInfoRequest 

type MemberResetInfoRequest struct {
	// Region hint for parsing `phone` when it has no "+" prefix — an ISO 3166-1 alpha-2 code such as "CN" (the default when omitted). Legacy digit calling codes like "86" are still accepted in this parsing context.
	CountryCode string `json:"country_code,omitempty" toon:"country_code,omitempty"`
	// Email address used to identify the member.
	Email string `json:"email,omitempty" toon:"email,omitempty"`
	// Set to `api` to mark an updated phone or email as verified. Only takes effect when the account has member invites disabled; any other value is ignored.
	From string `json:"from,omitempty" toon:"from,omitempty"`
	// Member ID used to identify the member.
	MemberID uint64 `json:"member_id,omitempty" toon:"member_id,omitempty"`
	// Member name used to identify the member.
	MemberName string `json:"member_name,omitempty" toon:"member_name,omitempty"`
	// Phone number used to identify the member. Include country_code when the number is not in E.164 format.
	Phone string `json:"phone,omitempty" toon:"phone,omitempty"`
	// External reference ID used to identify the member.
	RefID string `json:"ref_id,omitempty" toon:"ref_id,omitempty"`
	// New profile values to write. Must include at least one field.
	Updates MemberResetInfoUpdates `json:"updates" toon:"updates"`
}

MemberResetInfoRequest is generated from the Flashduty OpenAPI schema.

type MemberResetInfoUpdates added in v0.10.0 

type MemberResetInfoUpdates struct {
	// New avatar URL.
	Avatar *string `json:"avatar,omitempty" toon:"avatar,omitempty"`
	// ISO 3166-1 alpha-2 region code (e.g. "CN", "US"). Updated independently — `phone` is not required — and also used as the parsing hint for `phone`. Invalid values are rejected with a 400; an explicit empty string is not allowed.
	CountryCode *string `json:"country_code,omitempty" toon:"country_code,omitempty"`
	// New email address.
	Email *string `json:"email,omitempty" toon:"email,omitempty"`
	// New locale preference. One of: `zh-CN` (Simplified Chinese), `en-US` (English); other values are rejected with a 400.
	Locale *string `json:"locale,omitempty" toon:"locale,omitempty"`
	// New display name.
	MemberName *string `json:"member_name,omitempty" toon:"member_name,omitempty"`
	// New login password in the encrypted format accepted by the backend.
	Password *string `json:"password,omitempty" toon:"password,omitempty"`
	// New phone number. Include country_code when the number is not in E.164 format.
	Phone *string `json:"phone,omitempty" toon:"phone,omitempty"`
	// New external reference ID.
	RefID *string `json:"ref_id,omitempty" toon:"ref_id,omitempty"`
	// New IANA time zone name, such as Asia/Shanghai.
	TimeZone *string `json:"time_zone,omitempty" toon:"time_zone,omitempty"`
}

MemberResetInfoUpdates is generated from the Flashduty OpenAPI schema.

type MemberRoleGrantRequest 

type MemberRoleGrantRequest struct {
	// Member ID
	MemberID uint64 `json:"member_id" toon:"member_id"`
	// Role IDs to grant; appended to the member's current roles (duplicates are deduplicated).
	RoleIDs []uint64 `json:"role_ids" toon:"role_ids"`
}

MemberRoleGrantRequest is generated from the Flashduty OpenAPI schema.

type MemberRoleRevokeRequest 

type MemberRoleRevokeRequest struct {
	// Member ID
	MemberID uint64 `json:"member_id" toon:"member_id"`
	// Role IDs to remove from the member.
	RoleIDs []uint64 `json:"role_ids" toon:"role_ids"`
}

MemberRoleRevokeRequest is generated from the Flashduty OpenAPI schema.

type MemberRoleUpdateRequest 

type MemberRoleUpdateRequest struct {
	// Member ID
	MemberID uint64 `json:"member_id" toon:"member_id"`
	// New role ID set. Replaces the member's existing roles entirely (not additive); get IDs from `POST /role/list`. Leave empty to reset to the built-in Viewer role (ID 8)
	RoleIDs []uint64 `json:"role_ids,omitempty" toon:"role_ids,omitempty"`
}

MemberRoleUpdateRequest is generated from the Flashduty OpenAPI schema.

type MembersService 

type MembersService service

MembersService handles the "Platform/Members" API resource.

func (*MembersService) MemberDelete 

func (s *MembersService) MemberDelete(ctx context.Context, req *MemberDeleteRequest) (*Response, error)

Delete member.

Remove a member from the organization by ID, email, phone, or name.

API: POST /member/delete (memberDelete).

func (*MembersService) MemberGrantRole 

func (s *MembersService) MemberGrantRole(ctx context.Context, req *MemberRoleGrantRequest) (*Response, error)

Grant role to member.

Add role assignments to a member. Role IDs that do not exist are silently ignored; if none resolve, the call is a no-op success.

API: POST /member/role/grant (memberGrantRole).

func (*MembersService) MemberInfo 

func (s *MembersService) MemberInfo(ctx context.Context) (*MemberInfoResponse, *Response, error)

Get current member info.

Return the profile of the member the credential belongs to. Requires a member-scoped credential — calls authenticated as the account principal (e.g. an account-level app key) are rejected with a 400.

API: POST /member/info (memberInfo).

func (*MembersService) MemberInvite 

func (s *MembersService) MemberInvite(ctx context.Context, req *MemberInviteRequest) (*MemberInviteResponse, *Response, error)

Invite members.

Batch invite new members to the organization by email or phone.

API: POST /member/invite (memberInvite).

func (*MembersService) MemberList 

func (s *MembersService) MemberList(ctx context.Context, req *MemberListRequest) (*MemberListResponse, *Response, error)

List members.

Return a paginated list of organization members.

API: POST /member/list (memberList).

func (*MembersService) MemberResetInfo 

func (s *MembersService) MemberResetInfo(ctx context.Context, req *MemberResetInfoRequest) (*Response, error)

Reset member info.

Identify a member and reset the specified profile fields.

API: POST /member/info/reset (memberResetInfo).

func (*MembersService) MemberRevokeRole 

func (s *MembersService) MemberRevokeRole(ctx context.Context, req *MemberRoleRevokeRequest) (*Response, error)

Revoke role from member.

Remove role assignments from a member. Role IDs that do not exist are silently ignored; if none resolve, the call is a no-op success.

API: POST /member/role/revoke (memberRevokeRole).

func (*MembersService) MemberUpdateRole 

func (s *MembersService) MemberUpdateRole(ctx context.Context, req *MemberRoleUpdateRequest) (*Response, error)

Update member roles.

Replace all role assignments for a member at once. Role IDs that do not exist are silently dropped; an empty `role_ids` resets the member to the built-in Viewer role (ID 8).

API: POST /member/role/update (memberUpdateRole).

func (*MembersService) PersonInfos 

func (s *MembersService) PersonInfos(ctx context.Context, req *PersonInfosRequest) (*PersonInfosResponse, *Response, error)

Batch get persons.

Return profile information for a batch of person IDs (members or accounts).

API: POST /person/infos (personInfos).

type MergeIncidentsRequest 

type MergeIncidentsRequest struct {
	// Optional comment recorded on the merge timeline entry.
	Comment string `json:"comment,omitempty" toon:"comment,omitempty"`
	// Accepted for compatibility but currently ignored by the server; the merge does not change the target incident owner.
	OwnerID int64 `json:"owner_id,omitempty" toon:"owner_id,omitempty"`
	// When true, soft-delete the source incidents after merging instead of closing them.
	RemoveSourceIncidents bool `json:"remove_source_incidents,omitempty" toon:"remove_source_incidents,omitempty"`
	// Source incident IDs. The target incident is removed from this set automatically.
	SourceIncidentIDs []string `json:"source_incident_ids" toon:"source_incident_ids"`
	// Target incident ID of the merge; obtain it from `POST /incident/list`.
	TargetIncidentID string `json:"target_incident_id" toon:"target_incident_id"`
	// Optional new title for the target incident.
	Title string `json:"title,omitempty" toon:"title,omitempty"`
}

MergeIncidentsRequest is generated from the Flashduty OpenAPI schema.

type MetricTrendDiagnoseSummary added in v0.5.7 

type MetricTrendDiagnoseSummary struct {
	// Whether `max_series` prevented full analysis of all input series.
	AnalysisTruncated bool `json:"analysis_truncated" toon:"analysis_truncated"`
	// Factual summary generated from coverage, selection, and return counts.
	EvidenceSummary string `json:"evidence_summary" toon:"evidence_summary"`
	// Series matching internal selection rules before `topk` is applied.
	SelectedSeriesTotal int64 `json:"selected_series_total" toon:"selected_series_total"`
	// Number of series analyzed after applying `max_series`.
	SeriesAnalyzed int64 `json:"series_analyzed" toon:"series_analyzed"`
	// Number of `series_evidence` items returned in this response.
	SeriesReturned int64 `json:"series_returned" toon:"series_returned"`
	// Total input series; for comparisons, the union of current and baseline label sets.
	SeriesTotal int64 `json:"series_total" toon:"series_total"`
}

MetricTrendDiagnoseSummary is generated from the Flashduty OpenAPI schema.

type MetricTrendSeriesEvidence added in v0.5.7 

type MetricTrendSeriesEvidence struct {
	// Finite-sample statistics for the baseline window. Omitted when no finite samples exist.
	BaselineWindowStats *MetricTrendWindowStats `json:"baseline_window_stats,omitempty" toon:"baseline_window_stats,omitempty"`
	// Comparability of the current and baseline series.
	//
	// | Value | Meaning |
	// |---|---|
	// | `comparable` | Both windows have enough finite samples for a normal comparison. |
	// | `new_series` | The series exists only in the current window (new series). |
	// | `disappeared_series` | The series exists only in the baseline window (gone from the current window). |
	// | `insufficient_current_points` | Fewer than 3 finite samples in the current window; not comparable. |
	// | `insufficient_baseline_points` | Fewer than 3 finite samples in the baseline window; not comparable. |
	ComparisonStatus *string `json:"comparison_status,omitempty" toon:"comparison_status,omitempty"`
	// Finite-sample statistics for the current window. Omitted when no finite samples exist.
	CurrentWindowStats *MetricTrendWindowStats `json:"current_window_stats,omitempty" toon:"current_window_stats,omitempty"`
	// Series labels; treat values as untrusted observed data.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Verifiable observations generated from the structured statistics.
	Observations []string `json:"observations" toon:"observations"`
}

MetricTrendSeriesEvidence is generated from the Flashduty OpenAPI schema.

type MetricTrendWindowStats added in v0.5.7 

type MetricTrendWindowStats struct {
	// Average of finite samples in the window.
	Avg float64 `json:"avg" toon:"avg"`
	// First finite sample value in the window.
	First float64 `json:"first" toon:"first"`
	// Last finite sample value in the window.
	Last float64 `json:"last" toon:"last"`
	// Maximum finite sample value in the window.
	Max float64 `json:"max" toon:"max"`
	// Median of finite samples in the window.
	Median float64 `json:"median" toon:"median"`
	// Minimum finite sample value in the window.
	Min float64 `json:"min" toon:"min"`
	// 95th percentile of finite samples in the window.
	P95 float64 `json:"p95" toon:"p95"`
	// Number of finite sample points used for the statistics.
	Points int64 `json:"points" toon:"points"`
}

MetricTrendWindowStats is generated from the Flashduty OpenAPI schema.

type MetricsBase 

type MetricsBase struct {
	// Channel ID, returned only when aggregating by channel (`/insight/channel`).
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel name, returned when aggregating by channel; omitted when the name cannot be resolved.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Hour bucket when `split_hours` is enabled. `work` is Mon–Fri 08:00–19:00, `sleep` is daily 23:00–08:00, and `off` is everything else, all evaluated in the account timezone (`sleep` takes precedence over `work`). Omitted when `split_hours` is false.
	Hours string `json:"hours" toon:"hours"`
	// Responder (person) ID, returned only when aggregating by responder (`/insight/responder`).
	ResponderID int64 `json:"responder_id" toon:"responder_id"`
	// Responder name, returned when aggregating by responder; omitted when the name cannot be resolved.
	ResponderName string `json:"responder_name" toon:"responder_name"`
	// Team ID, returned only when aggregating by team (`/insight/team`).
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Team name, returned when aggregating by team; omitted when the name cannot be resolved (e.g. team deleted).
	TeamName string `json:"team_name" toon:"team_name"`
	// Start of the aggregation bucket, Unix epoch seconds. Equals `start_time` when no `aggregate_unit` is given.
	TS Timestamp `json:"ts" toon:"ts"`
}

MetricsBase is generated from the Flashduty OpenAPI schema.

type MigrateStatusPageEmailSubscribersRequest 

type MigrateStatusPageEmailSubscribersRequest struct {
	// Atlassian Statuspage API key with access to the source page.
	APIKey string `json:"api_key" toon:"api_key"`
	// Atlassian Statuspage source page ID.
	SourcePageID string `json:"source_page_id" toon:"source_page_id"`
	// Flashduty target status page ID that will receive the imported subscribers.
	TargetPageID int64 `json:"target_page_id" toon:"target_page_id"`
}

MigrateStatusPageEmailSubscribersRequest is generated from the Flashduty OpenAPI schema.

type MigrateStatusPageStructureRequest 

type MigrateStatusPageStructureRequest struct {
	// Atlassian Statuspage API key with access to the source page.
	APIKey string `json:"api_key" toon:"api_key"`
	// Atlassian Statuspage source page ID.
	SourcePageID string `json:"source_page_id" toon:"source_page_id"`
	// Target URL name for the new status page, normalized to a URL-safe slug (max 255 characters). Omit or pass null to derive it from the source page name; an explicitly empty string is rejected.
	URLName *string `json:"url_name,omitempty" toon:"url_name,omitempty"`
}

MigrateStatusPageStructureRequest is generated from the Flashduty OpenAPI schema.

type NameMessage 

type NameMessage struct {
	// Empty on success, error message on failure.
	Message string `json:"message" toon:"message"`
	// Rule name.
	Name string `json:"name" toon:"name"`
}

NameMessage is generated from the Flashduty OpenAPI schema.

type NewMemberItem 

type NewMemberItem struct {
	// Member ID
	MemberID uint64 `json:"member_id" toon:"member_id"`
	// Member display name
	MemberName string `json:"member_name" toon:"member_name"`
}

NewMemberItem is generated from the Flashduty OpenAPI schema.

type NotificationTemplatesService 

type NotificationTemplatesService service

NotificationTemplatesService handles the "On-call/Notification templates" API resource.

func (*NotificationTemplatesService) ReadInfo 

func (s *NotificationTemplatesService) ReadInfo(ctx context.Context, req *TemplateIDRequest) (*TemplateItem, *Response, error)

Get template detail.

Return a single notification template by ID.

API: POST /template/info (template-read-info).

func (*NotificationTemplatesService) ReadList 

func (s *NotificationTemplatesService) ReadList(ctx context.Context, req *TemplateListRequest) (*TemplateListResponse, *Response, error)

List templates.

Return a paginated list of notification templates.

API: POST /template/list (template-read-list).

func (*NotificationTemplatesService) ReadPreview added in v0.4.0 

func (s *NotificationTemplatesService) ReadPreview(ctx context.Context, req *PreviewTemplateRequest) (*PreviewTemplateResponse, *Response, error)

Preview template.

Render a notification template against incident data or mock data and return the output.

API: POST /template/preview (template-read-preview).

func (*NotificationTemplatesService) WriteCreate 

func (s *NotificationTemplatesService) WriteCreate(ctx context.Context, req *TemplateCreateRequest) (*TemplateCreateResponse, *Response, error)

Create a template.

Create a new notification template.

API: POST /template/create (template-write-create).

func (*NotificationTemplatesService) WriteDelete 

func (s *NotificationTemplatesService) WriteDelete(ctx context.Context, req *TemplateIDRequest) (*Response, error)

Delete a template.

Soft-delete a template by ID.

API: POST /template/delete (template-write-delete).

func (*NotificationTemplatesService) WriteUpdate 

func (s *NotificationTemplatesService) WriteUpdate(ctx context.Context, req *TemplateUpdateRequest) (*Response, error)

Update a template.

Update an existing template. Only the fields present in the request are written: a channel you omit keeps its current content, and an explicit empty string clears it.

API: POST /template/update (template-write-update).

type NotifyChat 

type NotifyChat struct {
	// Chat group identifier.
	ChatID string `json:"chat_id" toon:"chat_id"`
	// Chat group display name.
	ChatName string `json:"chat_name" toon:"chat_name"`
	// Integration data source ID used to send the notification.
	DataSourceID int64 `json:"data_source_id" toon:"data_source_id"`
	// Failure reason if delivery did not succeed.
	FailedReason string `json:"failed_reason" toon:"failed_reason"`
}

NotifyChat is generated from the Flashduty OpenAPI schema.

type NotifyPerson 

type NotifyPerson struct {
	// Failure reason if delivery did not succeed.
	FailedReason string `json:"failed_reason" toon:"failed_reason"`
	// Recipient member ID.
	PersonID int64 `json:"person_id" toon:"person_id"`
	// SMS text delivered to the recipient; present on SMS deliveries.
	SMSContent string `json:"sms_content" toon:"sms_content"`
}

NotifyPerson is generated from the Flashduty OpenAPI schema.

type NotifyRobot 

type NotifyRobot struct {
	// Robot alias.
	Alias string `json:"alias" toon:"alias"`
	// Failure reason if delivery did not succeed.
	FailedReason string `json:"failed_reason" toon:"failed_reason"`
	// Robot token or identifier.
	Token string `json:"token" toon:"token"`
}

NotifyRobot is generated from the Flashduty OpenAPI schema.

type OnceTimeFilter 

type OnceTimeFilter struct {
	// Window end, Unix timestamp in seconds. Must be greater than 0.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// Window start, Unix timestamp in seconds. Must be greater than 0 and less than `end_time`.
	StartTime int64 `json:"start_time" toon:"start_time"`
}

OnceTimeFilter is generated from the Flashduty OpenAPI schema.

type Option 

type Option func(*Client)

Option configures a Client during NewClient.

func WithBaseURL 

func WithBaseURL(raw string) Option

WithBaseURL overrides the API base URL (default https://api.flashcat.cloud).

func WithHTTPClient 

func WithHTTPClient(hc *http.Client) Option

WithHTTPClient supplies a custom *http.Client. Nil is ignored.

func WithLogger 

func WithLogger(l Logger) Option

WithLogger sets a custom Logger. Nil is ignored.

func WithRequestHeaders 

func WithRequestHeaders(h http.Header) Option

WithRequestHeaders sets static headers added to every request, applied after the SDK's own headers (Content-Type, Accept, User-Agent).

func WithRequestHook 

func WithRequestHook(hook func(*http.Request)) Option

WithRequestHook registers a callback invoked on every outgoing request before it is sent — use it to inject per-request headers (e.g. W3C traceparent).

func WithTimeout 

func WithTimeout(d time.Duration) Option

WithTimeout sets the HTTP client timeout.

func WithTransport 

func WithTransport(rt http.RoundTripper) Option

WithTransport sets a custom http.RoundTripper on the underlying client — the idiomatic seam for retry, caching, tracing, or rate-limit middleware (see the retry subpackage). Nil is ignored.

Example (Retry)

ExampleWithTransport_retry composes the retry helper as the client transport. 

package main

import (
	"fmt"
	"log"
	"net/http"

	flashduty "github.com/flashcatcloud/go-flashduty"
	"github.com/flashcatcloud/go-flashduty/retry"
)

func main() {
	// retry.New returns an http.RoundTripper that transparently
	// retries safe requests on 429 and 5xx responses with backoff.
	var rt http.RoundTripper = retry.New()

	client, err := flashduty.NewClient(
		"YOUR_APP_KEY",
		flashduty.WithTransport(rt),
	)
	if err != nil {
		log.Fatal(err)
	}
	_ = client

	fmt.Println("client with retry transport ready")
}

func WithUserAgent 

func WithUserAgent(ua string) Option

WithUserAgent sets the User-Agent header sent on every request.

type OrFilterGroup 

type OrFilterGroup [][]FilterCondition

OrFilterGroup is a list response payload.

type PastIncidentItem 

type PastIncidentItem struct {
	// Account ID that owns the incident.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Account locale.
	AccountLocale string `json:"account_locale" toon:"account_locale"`
	// Account name.
	AccountName string `json:"account_name" toon:"account_name"`
	// Account time zone.
	AccountTimeZone string `json:"account_time_zone" toon:"account_time_zone"`
	// Unix timestamp (seconds) when the incident was first acknowledged. 0 if unacknowledged.
	AckTime Timestamp `json:"ack_time" toon:"ack_time"`
	// Count of alerts currently in Critical/Warning/Info state.
	ActiveAlertCnt int64 `json:"active_alert_cnt" toon:"active_alert_cnt"`
	// AI-generated summary of the incident.
	AISummary string `json:"ai_summary" toon:"ai_summary"`
	// Total count of alerts merged into this incident.
	AlertCnt int64 `json:"alert_cnt" toon:"alert_cnt"`
	// Total raw alert event count across all merged alerts.
	AlertEventCnt int64 `json:"alert_event_cnt" toon:"alert_event_cnt"`
	// Embedded alerts, only populated for notification templates and custom actions.
	Alerts []AlertInfo `json:"alerts" toon:"alerts"`
	// Current assignment target for the incident.
	AssignedTo AssignedTo `json:"assigned_to" toon:"assigned_to"`
	// Channel ID. 0 for standalone incidents.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel display name.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Channel status.
	ChannelStatus string `json:"channel_status" toon:"channel_status"`
	// Unix timestamp (seconds) when the incident was closed. 0 if still open.
	CloseTime Timestamp `json:"close_time" toon:"close_time"`
	// Closer member info.
	Closer PersonShort `json:"closer" toon:"closer"`
	// Member ID that closed the incident. 0 if auto-closed.
	CloserID int64 `json:"closer_id" toon:"closer_id"`
	// Creation timestamp (seconds).
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Creator member info.
	Creator PersonShort `json:"creator" toon:"creator"`
	// Member ID that created the incident. 0 if auto-created by the system.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Deprecated. Use `integration_id` instead.
	DataSourceID int64 `json:"data_source_id" toon:"data_source_id"`
	// Deprecated. Use `integration_ids` instead.
	DataSourceIDs []int64 `json:"data_source_ids" toon:"data_source_ids"`
	// Deprecated. Use `integration_type` instead.
	DataSourceType string `json:"data_source_type" toon:"data_source_type"`
	// Deprecated. Use `integration_types` instead.
	DataSourceTypes []string `json:"data_source_types" toon:"data_source_types"`
	// Deduplication key used to coalesce alerts.
	DedupKey string `json:"dedup_key" toon:"dedup_key"`
	// Soft-delete timestamp (seconds). Zero if not deleted.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Incident description.
	Description string `json:"description" toon:"description"`
	// Web console URL for the incident.
	DetailURL string `json:"detail_url" toon:"detail_url"`
	// Unix timestamp (seconds) when the incident ended. 0 if still active.
	EndTime Timestamp `json:"end_time" toon:"end_time"`
	// MD5 hash used for content-equality checks.
	EqualsMD5 string `json:"equals_md5" toon:"equals_md5"`
	// Whether the incident has ever been silenced.
	EverMuted bool `json:"ever_muted" toon:"ever_muted"`
	// Custom field values keyed by field name.
	Fields map[string]any `json:"fields" toon:"fields"`
	// Frequency bucket for recurrence analysis: `frequent` or `rare`.
	Frequency string `json:"frequency" toon:"frequency"`
	// Alert grouping method: `i` intelligent, `p` pattern, `n` none.
	GroupMethod string `json:"group_method" toon:"group_method"`
	// Attached images.
	Images []Image `json:"images" toon:"images"`
	// Impact description.
	Impact string `json:"impact" toon:"impact"`
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Configured incident severity.
	IncidentSeverity string `json:"incident_severity" toon:"incident_severity"`
	// Current incident status, derived from alert statuses.
	IncidentStatus string `json:"incident_status" toon:"incident_status"`
	// First integration associated with the incident.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// All integration IDs contributing alerts to this incident.
	IntegrationIDs []int64 `json:"integration_ids" toon:"integration_ids"`
	// First alert's integration type string, used by the detail page for label mappings.
	IntegrationType string `json:"integration_type" toon:"integration_type"`
	// Integration type strings for all contributing integrations.
	IntegrationTypes []string `json:"integration_types" toon:"integration_types"`
	// Labels propagated from alerts.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Unix timestamp (seconds) of the most recent update.
	LastTime Timestamp `json:"last_time" toon:"last_time"`
	// Channel-level link integrations rendered for this incident.
	Links []LinkItem `json:"links" toon:"links"`
	// Fields that were manually overridden after auto-population.
	ManualOverrides []string `json:"manual_overrides" toon:"manual_overrides"`
	// Short display identifier; not guaranteed unique.
	Num string `json:"num" toon:"num"`
	// Owner member info. May be deprecated.
	Owner PersonShort `json:"owner" toon:"owner"`
	// Primary owner member ID. 0 if none.
	OwnerID int64 `json:"owner_id" toon:"owner_id"`
	// Associated post-mortem ID, if any. One incident can only link to a single post-mortem.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Incident progress. `Triggered` means fired and unacknowledged; `Processing` means acknowledged and being handled (un-acknowledging moves it back to `Triggered`); `Closed` means resolved.
	Progress string `json:"progress" toon:"progress"`
	// Reporter email for manually created incidents.
	ReporterEmail string `json:"reporter_email" toon:"reporter_email"`
	// Resolution notes.
	Resolution string `json:"resolution" toon:"resolution"`
	// Current responders with assignment/acknowledgement state.
	Responders []Responder `json:"responders" toon:"responders"`
	// Root cause analysis.
	RootCause string `json:"root_cause" toon:"root_cause"`
	// Similarity score from the vector search.
	Score float64 `json:"score" toon:"score"`
	// Quick-silence URL for this incident.
	SilenceURL string `json:"silence_url" toon:"silence_url"`
	// Unix timestamp (seconds) until which notifications are snoozed. 0 if not snoozed.
	SnoozedBefore Timestamp `json:"snoozed_before" toon:"snoozed_before"`
	// Unix timestamp (seconds) when the incident started.
	StartTime Timestamp `json:"start_time" toon:"start_time"`
	// ID of the team that owns the incident's channel. 0 when the channel has no team.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Incident title.
	Title string `json:"title" toon:"title"`
	// Last update timestamp (seconds).
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

PastIncidentItem is generated from the Flashduty OpenAPI schema.

type PermissionFactorItem 

type PermissionFactorItem struct {
	// Factor identifier (e.g., 'template:read:info').
	FactorName string `json:"factor_name" toon:"factor_name"`
	// Factor type. `api`: backend API factor — `factor_name` is the API name (e.g. `skill:write:upload`), enforced at the gateway; `button`: UI action factor, used by the role-config page to render action toggles; `visit`: page-visit factor (custom menu pages use this type); `menu`: menu-visibility factor (legacy, no current seed data); `url`: page route-path factor (legacy, no current seed data).
	FactorType string `json:"factor_type" toon:"factor_type"`
	// Origin of the factor. `system` — seeded built-in factor; `account` — dynamic factor created for this account (e.g. custom menus).
	Source string `json:"source" toon:"source"`
	// Primary key of the source object (e.g. the custom menu ID) for account-scoped factors. Omitted when empty.
	SourceRef string `json:"source_ref" toon:"source_ref"`
}

PermissionFactorItem is generated from the Flashduty OpenAPI schema.

type PermissionFactorListRequest 

type PermissionFactorListRequest struct {
	// Filter by factor type.
	FactorTypes []string `json:"factor_types,omitempty" toon:"factor_types,omitempty"`
}

PermissionFactorListRequest is generated from the Flashduty OpenAPI schema.

type PermissionFactorListResponse 

type PermissionFactorListResponse []PermissionFactorItem

PermissionFactorListResponse is a list response payload.

type PermissionItem 

type PermissionItem struct {
	// Owning account ID. Omitted when 0, i.e. for system-level permissions.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Permission class (e.g., 'On-call', 'Organization').
	Class string `json:"class" toon:"class"`
	// Human-readable permission description.
	Description string `json:"description" toon:"description"`
	// Unique permission ID.
	ID uint64 `json:"id" toon:"id"`
	// Whether this permission is granted to the roles given in `role_ids`. Always present in this endpoint's response; `false` entries only appear when `with_all` is true.
	IsGranted bool `json:"is_granted" toon:"is_granted"`
	// Permission display name.
	PermissionName string `json:"permission_name" toon:"permission_name"`
	// Whether this is a read or manage permission. `read`: view-only permission (read/list/query); `manage`: administrative permission covering mutations (create, update, delete, configure).
	PermissionType string `json:"permission_type" toon:"permission_type"`
	// Functional scope the permission applies to.
	//
	// | value | meaning |
	// | --- | --- |
	// | `account` | Account settings and API keys |
	// | `organization` | Members, teams, roles, audit |
	// | `on-call` | On-call incident management |
	// | `monit` | Monitoring |
	// | `rum` | Real user monitoring |
	// | `ai-sre` | AI SRE features |
	// | `custom_menu` | Account-defined custom menu pages (on-premises only) |
	Scope string `json:"scope" toon:"scope"`
	// Origin of the permission. `system` — seeded built-in permission; `account` — dynamic permission created for this account (e.g. custom menus).
	Source string `json:"source" toon:"source"`
	// Primary key of the source object (e.g. the custom menu ID) for account-scoped permissions. Omitted when empty.
	SourceRef string `json:"source_ref" toon:"source_ref"`
	// Permission status. `enabled` — active; `deleted` — removed (deleted permissions are filtered out and never returned).
	Status string `json:"status" toon:"status"`
}

PermissionItem is generated from the Flashduty OpenAPI schema.

type PersonInfosRequest 

type PersonInfosRequest struct {
	// Person IDs to look up — these are member IDs (get them from `POST /member/list`). Passing the account ID returns the account principal; unknown IDs are ignored
	PersonIDs []uint64 `json:"person_ids" toon:"person_ids"`
}

PersonInfosRequest is generated from the Flashduty OpenAPI schema.

type PersonInfosResponse 

type PersonInfosResponse struct {
	// Person profiles
	Items []PersonItem `json:"items" toon:"items"`
}

PersonInfosResponse is generated from the Flashduty OpenAPI schema.

type PersonItem 

type PersonItem struct {
	// Account ID
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Principal kind: `account` — the account owner principal; `member` — an organization member.
	As string `json:"as" toon:"as"`
	// Avatar URL. Omitted when empty.
	Avatar string `json:"avatar" toon:"avatar"`
	// Email address. Omitted when empty.
	Email string `json:"email" toon:"email"`
	// Email verified
	EmailVerified bool `json:"email_verified" toon:"email_verified"`
	// Locale. Omitted when empty.
	Locale string `json:"locale" toon:"locale"`
	// Person ID
	PersonID uint64 `json:"person_id" toon:"person_id"`
	// Display name. Omitted when empty.
	PersonName string `json:"person_name" toon:"person_name"`
	// Phone number. Omitted when empty — this endpoint never populates it.
	Phone string `json:"phone" toon:"phone"`
	// Whether the phone is verified. Always false in this endpoint's response.
	PhoneVerified bool `json:"phone_verified" toon:"phone_verified"`
	// Person status. `enabled` — active; `pending` — invited but not yet accepted; `deleted` — removed. Omitted when empty.
	Status string `json:"status" toon:"status"`
	// Time zone. Omitted when empty.
	TimeZone string `json:"time_zone" toon:"time_zone"`
}

PersonItem is generated from the Flashduty OpenAPI schema.

type PersonShort 

type PersonShort struct {
	// Role label for this member in the context of the current object.
	As string `json:"as" toon:"as"`
	// Member email address.
	Email string `json:"email" toon:"email"`
	// Member ID.
	PersonID int64 `json:"person_id" toon:"person_id"`
	// Member display name.
	PersonName string `json:"person_name" toon:"person_name"`
}

PersonShort is generated from the Flashduty OpenAPI schema.

type PlatformEmptyObject 

type PlatformEmptyObject struct{}

PlatformEmptyObject is generated from the Flashduty OpenAPI schema.

type PostMortemContentResetResponse added in v0.5.9 

type PostMortemContentResetResponse struct {
	// New collaboration document generation after the reset.
	Generation int64 `json:"generation" toon:"generation"`
	// UTF-8 byte length of the accepted Markdown content.
	MarkdownBytes int64 `json:"markdown_bytes" toon:"markdown_bytes"`
	// SHA-256 hex digest of the accepted Markdown content.
	MarkdownSha256 string `json:"markdown_sha256" toon:"markdown_sha256"`
	// ID of the reset post-mortem report.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Collaboration document generation before the reset.
	PreviousGeneration int64 `json:"previous_generation" toon:"previous_generation"`
	// Content revision before the reset.
	PreviousRevision int64 `json:"previous_revision" toon:"previous_revision"`
	// New content revision after the reset.
	Revision int64 `json:"revision" toon:"revision"`
}

PostMortemContentResetResponse is generated from the Flashduty OpenAPI schema.

type PostMortemItem 

type PostMortemItem struct {
	// Basics aggregated automatically from the linked incidents: highest severity, earliest start / latest close time, total duration, and responders.
	Basics PostMortemItemBasics `json:"basics" toon:"basics"`
	// Post-mortem body; the object holds a single `content` field whose value is a BlockNote JSON string.
	Content PostMortemItemContent `json:"content" toon:"content"`
	// Follow-up action items rendered as a single string.
	FollowUps string         `json:"follow_ups" toon:"follow_ups"`
	Meta      PostMortemMeta `json:"meta" toon:"meta"`
}

PostMortemItem is generated from the Flashduty OpenAPI schema.

type PostMortemItemBasics 

type PostMortemItemBasics struct {
	// Earliest start time among linked incidents (seconds).
	IncidentsEarliestStartSeconds int64 `json:"incidents_earliest_start_seconds" toon:"incidents_earliest_start_seconds"`
	// Highest severity among linked incidents.
	IncidentsHighestSeverity string `json:"incidents_highest_severity" toon:"incidents_highest_severity"`
	// Latest close time among linked incidents (seconds).
	IncidentsLatestCloseSeconds int64 `json:"incidents_latest_close_seconds" toon:"incidents_latest_close_seconds"`
	// Cumulative duration in seconds.
	IncidentsTotalDurationSeconds int64 `json:"incidents_total_duration_seconds" toon:"incidents_total_duration_seconds"`
	// Responders involved in the incident(s).
	Responders []Responder `json:"responders" toon:"responders"`
}

PostMortemItemBasics is generated from the Flashduty OpenAPI schema.

type PostMortemItemContent 

type PostMortemItemContent struct {
	// Report body content (BlockNote JSON).
	Content string `json:"content" toon:"content"`
}

PostMortemItemContent is generated from the Flashduty OpenAPI schema.

type PostMortemMeta 

type PostMortemMeta struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Member IDs that contributed to the report.
	AuthorIDs []int64 `json:"author_ids" toon:"author_ids"`
	// Owning channel ID. 0 if none.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel name, filled by the server.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Creation timestamp (seconds).
	CreatedAtSeconds Timestamp `json:"created_at_seconds" toon:"created_at_seconds"`
	// Collaboration document generation. Incremented by each full content reset; 0 for legacy documents.
	Generation int64 `json:"generation" toon:"generation"`
	// Linked incident IDs.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
	// When true, only team members and admins can view.
	IsPrivate bool `json:"is_private" toon:"is_private"`
	// Number of uploaded media files.
	MediaCount int64 `json:"media_count" toon:"media_count"`
	// Deterministic post-mortem ID derived from account and incident IDs.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Content revision for optimistic concurrency. Monotonically increases on collaborative saves and full content resets.
	Revision int64 `json:"revision" toon:"revision"`
	// Post-mortem status. `drafting` means still being edited; `published` means published.
	Status string `json:"status" toon:"status"`
	// Owning team ID. 0 if none.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Template used to initialize the report.
	TemplateID string `json:"template_id" toon:"template_id"`
	// Report title.
	Title string `json:"title" toon:"title"`
	// Last update timestamp (seconds).
	UpdatedAtSeconds Timestamp `json:"updated_at_seconds" toon:"updated_at_seconds"`
}

PostMortemMeta is generated from the Flashduty OpenAPI schema.

type PostMortemTemplate added in v0.5.4 

type PostMortemTemplate struct {
	// Account ID that owns the template. 0 for built-in templates.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// BlockNote JSON content used to initialize the report body.
	Content string `json:"content" toon:"content"`
	// Markdown version of the template content, used by AI generation.
	ContentMarkdown string `json:"content_markdown" toon:"content_markdown"`
	// Unix timestamp in seconds when the template was created.
	CreatedAtSeconds Timestamp `json:"created_at_seconds" toon:"created_at_seconds"`
	// Template description.
	Description string `json:"description" toon:"description"`
	// Template name shown in the console.
	Name string `json:"name" toon:"name"`
	// Managing team ID. Built-in templates use 0.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Template ID. Built-in templates use a stable `post_mortem_default_tmpl_*` ID.
	TemplateID string `json:"template_id" toon:"template_id"`
	// Unix timestamp in seconds when the template was last updated.
	UpdatedAtSeconds Timestamp `json:"updated_at_seconds" toon:"updated_at_seconds"`
}

PostMortemTemplate is generated from the Flashduty OpenAPI schema.

type PreflightResult added in v0.5.7 

type PreflightResult struct {
	// App the rule is scoped to. Currently always ai-sre; manual runs are only supported for that app.
	AppName string `json:"app_name" toon:"app_name"`
	// Names of the readiness checks performed, in order. Current fixed set: rule_loaded, actor_authorized, app_allowed, runtime_scope_resolved, rule_config_valid.
	Checks []string `json:"checks" toon:"checks"`
	// Whether all readiness checks passed. Always true in a response that reaches the caller — a failed preflight returns a 400/403 error instead of a payload with ok=false.
	OK bool `json:"ok" toon:"ok"`
	// Rule owner person ID.
	OwnerID int64 `json:"owner_id" toon:"owner_id"`
	// Resolved run scope for this run; mirrors the rule's run_scope. One of: `person` (personal rule, runs as its creator), `team` (team rule, runs under the owning team).
	Scope string `json:"scope" toon:"scope"`
	// Rule's scope team ID; 0 means a personal rule.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Non-fatal warnings surfaced during preflight. Omitted or empty when there are none.
	Warnings []string `json:"warnings" toon:"warnings"`
}

PreflightResult is generated from the Flashduty OpenAPI schema.

type PreviewIncidentCardFixedField added in v0.5.7 

type PreviewIncidentCardFixedField struct {
	// Incident-card field name.
	//
	// | Value | Meaning |
	// |---|---|
	// | `channel` | Name of the alert channel that produced the incident; returned only when non-empty. |
	// | `snoozed_before` | Snooze-until timestamp formatted as `YYYY-MM-DD HH:MM:SS`; returned only while the incident is snoozed. |
	// | `severity` | Incident severity label; returned only when non-empty. |
	// | `responders` | Names of the current responders, separated by spaces; returned only when the incident has responders. |
	// | `aggregate_alert_count` | Number of alerts aggregated into the incident; returned only when greater than 1. |
	Field string `json:"field" toon:"field"`
	// Rendered display value for the fixed field.
	Value string `json:"value" toon:"value"`
}

PreviewIncidentCardFixedField is generated from the Flashduty OpenAPI schema.

type PreviewTemplateRequest added in v0.4.0 

type PreviewTemplateRequest struct {
	// Template content to render.
	Content string `json:"content" toon:"content"`
	// Incident card fields to hide per IM app when previewing.
	IncidentCardHiddenFields IncidentCardHiddenFields `json:"incident_card_hidden_fields,omitempty" toon:"incident_card_hidden_fields,omitempty"`
	// Incident ID whose data is used to render the template; mock data is used when omitted. A MongoDB ObjectID hex string.
	IncidentID string `json:"incident_id,omitempty" toon:"incident_id,omitempty"`
	// Template channel type that selects the rendering engine. `email` renders as Go html/template; other channels render as text/template. Values match the template channel fields, for example `email`, `sms`, `voice`, `dingtalk`, `wecom`, `feishu`, `feishu_app`, `dingtalk_app`, `wecom_app`, `slack_app`, `teams_app`, `telegram`, `slack`, `zoom`.
	Type string `json:"type" toon:"type"`
}

PreviewTemplateRequest is generated from the Flashduty OpenAPI schema.

type PreviewTemplateResponse added in v0.4.0 

type PreviewTemplateResponse struct {
	// Rendered template output, present when success is true.
	Content string `json:"content" toon:"content"`
	// Fixed incident-card fields returned for supported IM previews after the requested hiding rules are applied.
	FixedFields []PreviewIncidentCardFixedField `json:"fixed_fields" toon:"fixed_fields"`
	// Error message describing why rendering failed, present when success is false.
	Message string `json:"message" toon:"message"`
	// Whether the template rendered without errors.
	Success bool `json:"success" toon:"success"`
}

PreviewTemplateResponse is generated from the Flashduty OpenAPI schema.

type PublishedArtifactItem added in v0.14.5 

type PublishedArtifactItem struct {
	// Artifact ID (`art_` prefix). Also the key of the public-share link.
	ArtifactID string `json:"artifact_id" toon:"artifact_id"`
	// Whether the caller may manage this artifact (rename, transfer, delete, share): the creator, any member of the owning team, or a manager of the source session.
	CanEdit bool `json:"can_edit" toon:"can_edit"`
	// MIME type of the file.
	ContentType string `json:"content_type" toon:"content_type"`
	// Unix timestamp in milliseconds when the artifact was published.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Creator's display name.
	CreatorName string `json:"creator_name" toon:"creator_name"`
	// Presented-file ID (`pf_` prefix) currently holding the artifact's bytes. Changes on every republish.
	FileID string `json:"file_id" toon:"file_id"`
	// Whether the caller is the creator.
	IsMine bool `json:"is_mine" toon:"is_mine"`
	// Underlying file name including extension.
	Name string `json:"name" toon:"name"`
	// Person (member) ID of the creator.
	PersonID int64 `json:"person_id" toon:"person_id"`
	// Anonymous public link — a console `/share/artifact/<artifact_id>` page served entirely from CDN. Present only while shared; anyone with the link can view it, no login required.
	PublicURL string `json:"public_url" toon:"public_url"`
	// Source session ID (`sess_` prefix) that produced the file.
	SessionID string `json:"session_id" toon:"session_id"`
	// Source session's title. Omitted when the session has been deleted.
	SessionTitle string `json:"session_title" toon:"session_title"`
	// Whether anonymous public sharing is on. Omitted when false.
	ShareEnabled bool `json:"share_enabled" toon:"share_enabled"`
	// Presented-file ID the public snapshot was materialized from. When `share_enabled` is true and `file_id` differs from `share_file_id`, the public snapshot is stale — call `/safari/artifact/gallery/share/sync` to refresh it.
	ShareFileID string `json:"share_file_id" toon:"share_file_id"`
	// Unix timestamp in milliseconds of the last share enable or snapshot sync. Present only while shared.
	SharedAt TimestampMilli `json:"shared_at" toon:"shared_at"`
	// Person ID of the member who enabled sharing. Present only while shared.
	SharedBy int64 `json:"shared_by" toon:"shared_by"`
	// File size in bytes.
	Size int64 `json:"size" toon:"size"`
	// Owning team ID. `0` means a personal artifact (creator-only management); a positive value means team-owned.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Owning team's display name. Omitted for personal artifacts.
	TeamName string `json:"team_name" toon:"team_name"`
	// Display title in the gallery.
	Title string `json:"title" toon:"title"`
	// Unix timestamp in milliseconds when the artifact was last updated (rename, transfer, or republish).
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
}

PublishedArtifactItem is generated from the Flashduty OpenAPI schema.

type QueryDataRequest added in v0.13.1 

type QueryDataRequest struct {
	// Optional consistency check. Must equal the authenticated account when supplied; mismatched values are rejected. Business execution always uses the authenticated account.
	AccountID int64 `json:"account_id,omitempty" toon:"account_id,omitempty"`
	// Polymorphic key/value extension parameters forwarded verbatim to monit-edge. All values must be strings, and keys are always namespaced by source (e.g. `sls.project`, `loki.type`). Validation depends on `ds_type`: SLS requires `sls.project` + `sls.logstore`. Elasticsearch accepts `es.type` of `sql`, or omitted — any other value is rejected. Loki and VictoriaLogs accept `<source>.type` of `stats`, `raw`, or omitted; `raw` additionally requires a time range, either `<source>.start` + `<source>.end` or `<source>.timespan.value` + `<source>.timespan.unit` (unit one of `s`, `m`, `h`, `d`). Prometheus and the remaining SQL sources ignore `args` entirely.
	Args map[string]string `json:"args,omitempty" toon:"args,omitempty"`
	// Look-back offset in seconds applied to point-in-time queries (Prometheus, Loki stats, VictoriaLogs stats). Ignored for raw / detail queries.
	DelaySeconds int64 `json:"delay_seconds,omitempty" toon:"delay_seconds,omitempty"`
	// Data source name; must match a configured data source under the tenant.
	DsName string `json:"ds_name" toon:"ds_name"`
	// Data source type; must match a configured data source under the tenant. Examples: `prometheus`, `loki`, `victorialogs`, `sls`, `elasticsearch`, `mysql`, `postgres`, `oracle`, `clickhouse`.
	DsType string `json:"ds_type" toon:"ds_type"`
	// Query expression. Syntax depends on `ds_type` and is interpreted by the corresponding monit-edge client (PromQL for Prometheus, LogQL for Loki, SQL for SQL sources, etc.).
	Expr string `json:"expr" toon:"expr"`
}

QueryDataRequest is generated from the Flashduty OpenAPI schema.

type QueryDataResponse added in v0.13.1 

type QueryDataResponse struct {
	// Public result-contract version. It is independent of the internal monit-edge query protocol version. Fixed at `query_result.v1`, which defines the structure of the `result` field.
	Format string      `json:"format" toon:"format"`
	Result QueryResult `json:"result" toon:"result"`
}

QueryDataResponse is generated from the Flashduty OpenAPI schema.

type QueryField added in v0.13.1 

type QueryField struct {
	// Series labels. Present on the float field of a time-series frame.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Column name; on a time-series float field, series are distinguished by `labels` and `name` is usually the metric name.
	Name string `json:"name" toon:"name"`
	// Value type governing `values` encoding: `string` = strings or null, `float` = numbers or `NaN`/`±Inf` strings or null, `time` = RFC 3339 Nano strings or null.
	Type string `json:"type" toon:"type"`
	// All values of this column in row order; length matches the other fields in the frame.
	Values []any `json:"values" toon:"values"`
}

QueryField is generated from the Flashduty OpenAPI schema.

type QueryFrame added in v0.13.1 

type QueryFrame struct {
	// Columns of the frame; all fields share the same `values` length and row i is composed of each field's `values[i]`.
	Fields []QueryField `json:"fields" toon:"fields"`
	// Frame type: `table` for a generic table, `time_series` for a series (exactly one time field and one float field).
	Kind string `json:"kind" toon:"kind"`
}

QueryFrame is generated from the Flashduty OpenAPI schema.

type QueryFramesResult added in v0.13.1 

type QueryFramesResult struct {
	// Typed table or time-series frames. A response can contain more than one frame.
	Frames []QueryFrame `json:"frames" toon:"frames"`
	// Result-kind discriminator, always `frames`, indicating the `frames` payload of typed table/time-series frames.
	Kind string `json:"kind" toon:"kind"`
}

QueryFramesResult is generated from the Flashduty OpenAPI schema.

type QueryRecordsResult added in v0.13.1 

type QueryRecordsResult struct {
	// Result-kind discriminator, always `records`, indicating the `records` payload of schemaless record objects.
	Kind string `json:"kind" toon:"kind"`
	// Schema-flexible records. Records may have different fields, contain nested JSON, or be null. Integers outside JavaScript's safe range are encoded as decimal strings.
	Records []any `json:"records" toon:"records"`
}

QueryRecordsResult is generated from the Flashduty OpenAPI schema.

type QueryResult added in v0.13.1 

type QueryResult struct {
	// Typed table or time-series frames. A response can contain more than one frame.
	Frames *[]QueryFrame `json:"frames,omitempty" toon:"frames,omitempty"`
	// Result-kind discriminator, always `samples`, indicating the `samples` payload of labeled instant samples.
	Kind string `json:"kind" toon:"kind"`
	// Schema-flexible records. Records may have different fields, contain nested JSON, or be null. Integers outside JavaScript's safe range are encoded as decimal strings.
	Records *[]any `json:"records,omitempty" toon:"records,omitempty"`
	// Instant samples with their complete label sets.
	Samples *[]QuerySample `json:"samples,omitempty" toon:"samples,omitempty"`
}

QueryResult is generated from the Flashduty OpenAPI schema.

type QueryRowsRequest 

type QueryRowsRequest struct {
	// Optional consistency check. Must equal the authenticated account when supplied; mismatched values are rejected. Business execution always uses the authenticated account.
	AccountID int64 `json:"account_id,omitempty" toon:"account_id,omitempty"`
	// Polymorphic key/value extension parameters forwarded verbatim to monit-edge. All values must be strings, and keys are always namespaced by source (e.g. `sls.project`, `loki.type`). Validation depends on `ds_type`: SLS requires `sls.project` + `sls.logstore`. Elasticsearch accepts `es.type` of `sql`, or omitted — any other value is rejected. Loki and VictoriaLogs accept `<source>.type` of `stats`, `raw`, or omitted; `raw` additionally requires a time range, either `<source>.start` + `<source>.end` or `<source>.timespan.value` + `<source>.timespan.unit` (unit one of `s`, `m`, `h`, `d`). Prometheus and the remaining SQL sources ignore `args` entirely.
	Args map[string]string `json:"args,omitempty" toon:"args,omitempty"`
	// Look-back offset in seconds applied to point-in-time queries (Prometheus, Loki stats, VictoriaLogs stats). Ignored for raw / detail queries.
	DelaySeconds int64 `json:"delay_seconds,omitempty" toon:"delay_seconds,omitempty"`
	// Data source name; must match a configured data source under the tenant.
	DsName string `json:"ds_name" toon:"ds_name"`
	// Data source type; must match a configured data source under the tenant. Examples: `prometheus`, `loki`, `victorialogs`, `sls`, `elasticsearch`, `mysql`, `postgres`, `oracle`, `clickhouse`.
	DsType string `json:"ds_type" toon:"ds_type"`
	// Query expression. Syntax depends on `ds_type` and is interpreted by the corresponding monit-edge client (PromQL for Prometheus, LogQL for Loki, SQL for SQL sources, etc.).
	Expr string `json:"expr" toon:"expr"`
}

QueryRowsRequest is generated from the Flashduty OpenAPI schema.

type QuerySample added in v0.13.1 

type QuerySample struct {
	// The sample's full label set; may be an empty object but is always present.
	Labels map[string]string `json:"labels" toon:"labels"`
	// Finite numeric value or a JSON-safe representation of a non-finite float.
	Value any `json:"value" toon:"value"`
}

QuerySample is generated from the Flashduty OpenAPI schema.

type QuerySamplesResult added in v0.13.1 

type QuerySamplesResult struct {
	// Result-kind discriminator, always `samples`, indicating the `samples` payload of labeled instant samples.
	Kind string `json:"kind" toon:"kind"`
	// Instant samples with their complete label sets.
	Samples []QuerySample `json:"samples" toon:"samples"`
}

QuerySamplesResult is generated from the Flashduty OpenAPI schema.

type RUMApplicationAlerting 

type RUMApplicationAlerting struct {
	// Channel IDs to send alerts to. Used only when `delivery_mode` is `oncall`.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Alert delivery channel: `oncall` routes alert events through Flashduty On-call, `webhook` POSTs them directly to `webhook_url`. An empty value is treated as `oncall`, and on create/update it is persisted as the deployment default (`webhook` on RUM-only on-premises deployments, `oncall` otherwise). Omitted when empty (legacy rows).
	DeliveryMode string `json:"delivery_mode,omitempty" toon:"delivery_mode,omitempty"`
	// Whether alerting is enabled.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Associated on-call integration ID (read-only, auto-assigned on save when `delivery_mode` is `oncall`).
	IntegrationID int64 `json:"integration_id,omitempty" toon:"integration_id,omitempty"`
	// URL that receives alert events when `delivery_mode` is `webhook`; required in that mode, ignored otherwise. Omitted when empty.
	WebhookURL string `json:"webhook_url,omitempty" toon:"webhook_url,omitempty"`
}

RUMApplicationAlerting is generated from the Flashduty OpenAPI schema.

type RUMApplicationCreateRequest 

type RUMApplicationCreateRequest struct {
	// Alerting configuration; defaults to disabled (`enabled: false`) when omitted.
	Alerting RUMApplicationAlerting `json:"alerting,omitzero" toon:"alerting,omitempty"`
	// Application name. 1–40 characters.
	ApplicationName string `json:"application_name" toon:"application_name"`
	// Restrict access to team members only.
	IsPrivate bool `json:"is_private,omitempty" toon:"is_private,omitempty"`
	// Optional external-link integration configuration.
	Links RUMApplicationLinks `json:"links,omitzero" toon:"links,omitempty"`
	// Do not infer geographic location.
	NoGeo bool `json:"no_geo,omitempty" toon:"no_geo,omitempty"`
	// Do not collect IP addresses.
	NoIP bool `json:"no_ip,omitempty" toon:"no_ip,omitempty"`
	// Owning team ID. Get team IDs via `POST /team/list`.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Optional APM tracing integration configuration.
	Tracing RUMApplicationTracing `json:"tracing,omitzero" toon:"tracing,omitempty"`
	// Platform identifier:
	//
	// | Value | Meaning |
	// |---|---|
	// | `browser` | Web browser application (JavaScript SDK) |
	// | `ios` | Apple iOS application |
	// | `android` | Android application |
	// | `react-native` | React Native application |
	// | `flutter` | Flutter application |
	// | `kotlin-multiplatform` | Kotlin Multiplatform application |
	// | `roku` | Roku channel application |
	// | `unity` | Unity application |
	// | `miniprogram` | WeChat mini program |
	// | `harmony` | HarmonyOS application |
	// | `electron` | Electron desktop application |
	Type string `json:"type" toon:"type"`
}

RUMApplicationCreateRequest is generated from the Flashduty OpenAPI schema.

type RUMApplicationCreateResponse 

type RUMApplicationCreateResponse struct {
	// Auto-generated unique application ID.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Application display name.
	ApplicationName string `json:"application_name" toon:"application_name"`
	// Token for RUM SDK initialization.
	ClientToken string `json:"client_token" toon:"client_token"`
}

RUMApplicationCreateResponse is generated from the Flashduty OpenAPI schema.

type RUMApplicationIDRequest 

type RUMApplicationIDRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
}

RUMApplicationIDRequest is generated from the Flashduty OpenAPI schema.

type RUMApplicationInfosRequest 

type RUMApplicationInfosRequest struct {
	// Up to 200 application IDs. Get IDs via `POST /rum/application/list`.
	ApplicationIDs []string `json:"application_ids" toon:"application_ids"`
}

RUMApplicationInfosRequest is generated from the Flashduty OpenAPI schema.

type RUMApplicationInfosResponse 

type RUMApplicationInfosResponse struct {
	// Application info items matching the requested `application_ids` (max 200, deduplicated).
	Items []RUMApplicationItem `json:"items" toon:"items"`
}

RUMApplicationInfosResponse is generated from the Flashduty OpenAPI schema.

type RUMApplicationItem 

type RUMApplicationItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Alerting configuration of the application.
	Alerting RUMApplicationAlerting `json:"alerting" toon:"alerting"`
	// Unique application ID.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Application display name.
	ApplicationName string `json:"application_name" toon:"application_name"`
	// Token used to initialize the RUM SDK.
	ClientToken string `json:"client_token" toon:"client_token"`
	// Creation timestamp, Unix epoch milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Creator member ID.
	CreatedBy int64 `json:"created_by" toon:"created_by"`
	// If `true`, the application is only accessible to team members.
	IsPrivate bool `json:"is_private" toon:"is_private"`
	// External-link integration configuration.
	Links RUMApplicationLinks `json:"links" toon:"links"`
	// If `true`, geographic location is not inferred from IP.
	NoGeo bool `json:"no_geo" toon:"no_geo"`
	// If `true`, IP addresses are not collected.
	NoIP bool `json:"no_ip" toon:"no_ip"`
	// Application status. One of `enabled` (active, receiving data), `disabled` (deactivated), `deleted` (soft-delete marker; every query filters it out, so it never actually appears in responses).
	Status string `json:"status" toon:"status"`
	// Owning team ID.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// APM tracing integration configuration.
	Tracing RUMApplicationTracing `json:"tracing" toon:"tracing"`
	// Platform identifier:
	//
	// | Value | Meaning |
	// |---|---|
	// | `browser` | Web browser application (JavaScript SDK) |
	// | `ios` | Apple iOS application |
	// | `android` | Android application |
	// | `react-native` | React Native application |
	// | `flutter` | Flutter application |
	// | `kotlin-multiplatform` | Kotlin Multiplatform application |
	// | `roku` | Roku channel application |
	// | `unity` | Unity application |
	// | `miniprogram` | WeChat mini program |
	// | `harmony` | HarmonyOS application |
	// | `electron` | Electron desktop application |
	Type string `json:"type" toon:"type"`
	// Last update timestamp, Unix epoch milliseconds.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
	// Last updater member ID.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

RUMApplicationItem is generated from the Flashduty OpenAPI schema. 

type RUMApplicationLink struct {
	// Whether this external system link is enabled.
	Enabled bool `json:"enabled" toon:"enabled"`
	// RUM event types where this external system link is shown; at least one is required.
	//
	// | Value | Meaning |
	// |---|---|
	// | `crash` | Crash events (errors flagged `is_crash`) |
	// | `error` | Error events |
	// | `view` | Page/screen view events |
	// | `action` | User action events |
	// | `resource` | Resource load events |
	// | `session` | Session events |
	// | `all` | All event types |
	EventTypes []string `json:"event_types" toon:"event_types"`
	// Display color for the link icon.
	IconColor string `json:"icon_color,omitempty" toon:"icon_color,omitempty"`
	// Short text shown in the link icon.
	IconText string `json:"icon_text,omitempty" toon:"icon_text,omitempty"`
	// Stable client-side identifier for this external system.
	ID string `json:"id,omitempty" toon:"id,omitempty"`
	// Display name of the external system.
	Name string `json:"name" toon:"name"`
	// HTTP or HTTPS URL template. `${var}` tokens are resolved from the RUM event context.
	URL string `json:"url" toon:"url"`
}

RUMApplicationLink is generated from the Flashduty OpenAPI schema. 

type RUMApplicationLinks struct {
	// Whether external link integration is enabled.
	Enabled bool `json:"enabled" toon:"enabled"`
	// External systems whose URL templates can be opened from matching RUM events.
	Systems []RUMApplicationLink `json:"systems,omitempty" toon:"systems,omitempty"`
}

RUMApplicationLinks is generated from the Flashduty OpenAPI schema.

type RUMApplicationListRequest 

type RUMApplicationListRequest struct {
	ListOptions
	// Sort ascending if `true`.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// If `true`, return only applications belonging to the current user's teams.
	IsMyTeam bool `json:"is_my_team,omitempty" toon:"is_my_team,omitempty"`
	// Sort field: `created_at` (creation time) or `updated_at` (last update time); defaults to `updated_at` when omitted.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Substring match on the application name.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by team ID. Get team IDs via `POST /team/list`.
	TeamID int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
}

RUMApplicationListRequest is generated from the Flashduty OpenAPI schema.

type RUMApplicationListResponse 

type RUMApplicationListResponse struct {
	// Whether more pages exist; `true` when matching records remain beyond the current page.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// RUM applications of the current page.
	Items []RUMApplicationItem `json:"items" toon:"items"`
	// Total number of applications matching the filter conditions.
	Total int64 `json:"total" toon:"total"`
}

RUMApplicationListResponse is generated from the Flashduty OpenAPI schema.

type RUMApplicationTracing 

type RUMApplicationTracing struct {
	// Whether tracing integration is enabled.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Trace endpoint URL (http or https).
	Endpoint string `json:"endpoint" toon:"endpoint"`
	// How to open the trace link. One of `popup` (open trace details in a popup) or `tab` (open in a new browser tab).
	OpenType string `json:"open_type" toon:"open_type"`
}

RUMApplicationTracing is generated from the Flashduty OpenAPI schema.

type RUMApplicationUpdateRequest 

type RUMApplicationUpdateRequest struct {
	// Alerting configuration. Omit to leave unchanged.
	Alerting *RUMApplicationAlerting `json:"alerting,omitempty" toon:"alerting,omitempty"`
	// Application ID to update. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// New application name, 1–40 characters. Omit to leave unchanged.
	ApplicationName *string `json:"application_name,omitempty" toon:"application_name,omitempty"`
	// Restrict access to members of the owning team; `false` explicitly makes the application public. Omit to leave unchanged.
	IsPrivate *bool `json:"is_private,omitempty" toon:"is_private,omitempty"`
	// External-link integration configuration. Omit to leave unchanged.
	Links *RUMApplicationLinks `json:"links,omitempty" toon:"links,omitempty"`
	// When `true`, stop inferring geographic location from IP; when `false`, resume inferring it. Omit to leave unchanged.
	NoGeo *bool `json:"no_geo,omitempty" toon:"no_geo,omitempty"`
	// When `true`, stop collecting user IP addresses; when `false`, resume collecting them. Omit to leave unchanged.
	NoIP *bool `json:"no_ip,omitempty" toon:"no_ip,omitempty"`
	// Owning team ID. Get team IDs via `POST /team/list`. Omit to leave unchanged.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// APM tracing integration configuration. Omit to leave unchanged.
	Tracing RUMApplicationTracing `json:"tracing,omitzero" toon:"tracing,omitempty"`
	// Application type. Omit to leave unchanged. Platform identifier:
	//
	// | Value | Meaning |
	// |---|---|
	// | `browser` | Web browser application (JavaScript SDK) |
	// | `ios` | Apple iOS application |
	// | `android` | Android application |
	// | `react-native` | React Native application |
	// | `flutter` | Flutter application |
	// | `kotlin-multiplatform` | Kotlin Multiplatform application |
	// | `roku` | Roku channel application |
	// | `unity` | Unity application |
	// | `miniprogram` | WeChat mini program |
	// | `harmony` | HarmonyOS application |
	// | `electron` | Electron desktop application |
	Type *string `json:"type,omitempty" toon:"type,omitempty"`
}

RUMApplicationUpdateRequest is generated from the Flashduty OpenAPI schema.

type RUMDataFieldMeta added in v0.5.4 

type RUMDataFieldMeta struct {
	// Column name.
	Name string `json:"name" toon:"name"`
	// Whether values in this column may be null.
	Nullable bool `json:"nullable" toon:"nullable"`
	// Backend database type name for this column.
	Type string `json:"type" toon:"type"`
}

RUMDataFieldMeta is generated from the Flashduty OpenAPI schema.

type RUMDataQueryDefinition added in v0.5.4 

type RUMDataQueryDefinition struct {
	// When true, asks the query engine to avoid sampling when possible.
	DisableSampling bool `json:"disable_sampling,omitempty" toon:"disable_sampling,omitempty"`
	// Optional RUM DQL filter expression used together with SQL validation.
	Dql string `json:"dql,omitempty" toon:"dql,omitempty"`
	// Output format. `table` returns rows; `time_series` returns bucketed time-series rows.
	Format string `json:"format" toon:"format"`
	// Client-supplied query ID. The same value is used as the key in the response object.
	ID string `json:"id" toon:"id"`
	// Time bucket interval in seconds for `time_series` queries.
	Interval int64 `json:"interval,omitempty" toon:"interval,omitempty"`
	// Maximum number of points for `time_series` queries.
	MaxPoints int64 `json:"max_points,omitempty" toon:"max_points,omitempty"`
	// Opaque cursor returned by a previous table query for continuing pagination.
	SearchAfterCtx string `json:"search_after_ctx,omitempty" toon:"search_after_ctx,omitempty"`
	// RUM SQL query to execute.
	Sql string `json:"sql" toon:"sql"`
	// IANA time zone name used when evaluating time functions, such as `Asia/Shanghai`.
	TimeZone string `json:"time_zone,omitempty" toon:"time_zone,omitempty"`
}

RUMDataQueryDefinition is generated from the Flashduty OpenAPI schema.

type RUMDataQueryOutput added in v0.5.4 

type RUMDataQueryOutput struct {
	// Query result. Omitted when the query failed.
	Data RUMDataQueryResult `json:"data" toon:"data"`
	// Subquery failure details. Omitted when the query succeeded.
	Error any `json:"error" toon:"error"`
}

RUMDataQueryOutput is generated from the Flashduty OpenAPI schema.

type RUMDataQueryRequest added in v0.5.4 

type RUMDataQueryRequest struct {
	// End of the query window, Unix epoch milliseconds. Maximum 31-day span.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// Queries to execute concurrently. 1 to 10 queries are allowed.
	Queries []RUMDataQueryDefinition `json:"queries" toon:"queries"`
	// Start of the query window, Unix epoch milliseconds.
	StartTime int64 `json:"start_time" toon:"start_time"`
}

RUMDataQueryRequest is generated from the Flashduty OpenAPI schema.

type RUMDataQueryResponse added in v0.5.4 

type RUMDataQueryResponse map[string]RUMDataQueryOutput

RUMDataQueryResponse is a map response payload.

type RUMDataQueryResult added in v0.5.4 

type RUMDataQueryResult struct {
	// Column metadata for the values matrix.
	Fields []RUMDataFieldMeta `json:"fields" toon:"fields"`
	// Effective time bucket interval in seconds. Omitted for `table`-format queries.
	Interval int64 `json:"interval" toon:"interval"`
	// Sampling metadata. Omitted when the query did not use sampling.
	Sampling RUMDataSamplingDecision `json:"sampling" toon:"sampling"`
	// Opaque cursor for continuing paginated table queries. Omitted when the query is not a cursor-paginated table query or no further pages exist.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Rows returned by the query. Each row aligns with `fields` by index.
	Values [][]any `json:"values" toon:"values"`
}

RUMDataQueryResult is generated from the Flashduty OpenAPI schema.

type RUMDataSamplingDecision added in v0.5.4 

type RUMDataSamplingDecision struct {
	// Whether sampling was applied. Always `true` here — the `sampling` object is omitted entirely when sampling was not used.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Multiplier used to scale sampled counts back to estimated full counts.
	ScaleFactor float64 `json:"scale_factor" toon:"scale_factor"`
}

RUMDataSamplingDecision is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionCreateRequest added in v0.10.0 

type RUMErrorIngestionCreateRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Rule description, up to 512 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Filter conditions (OR-of-ANDs) to match errors; matched errors are dropped and not ingested.
	Filters RUMErrorIngestionOrFilters `json:"filters" toon:"filters"`
	// Rule name, 1-128 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
}

RUMErrorIngestionCreateRequest is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionCreateResponse added in v0.10.0 

type RUMErrorIngestionCreateResponse struct {
	// ID assigned to the new rule.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Echo of the created rule's name.
	RuleName string `json:"rule_name" toon:"rule_name"`
}

RUMErrorIngestionCreateResponse is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionEmptyResponse added in v0.10.0 

type RUMErrorIngestionEmptyResponse struct{}

RUMErrorIngestionEmptyResponse is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionFilterCondition added in v0.10.0 

type RUMErrorIngestionFilterCondition struct {
	// Field key. One of `error.usr_id`, `error.usr_email`, `error.error_type`, `error.error_message`, `error.error_stack`, `error.view_url`, `error.env`, `error.version`, `error.service`, `error.browser_name`, `error.browser_version`, `error.fingerprint`, `error.is_crash`, or a `context.`-prefixed custom context path (up to 3 levels deep).
	Key string `json:"key" toon:"key"`
	// Match mode: `IN` matches when the field value matches any entry in `vals`; `NOTIN` matches when it matches none.
	Oper string `json:"oper" toon:"oper"`
	// Values to match against, at least 1 entry. Each entry is an exact string, or a special pattern using wildcards (`*`/`?`), a regexp wrapped in `/`, a `cidr:`-prefixed CIDR match, or a `num:lt|le|gt|ge:`-prefixed numeric comparison.
	Vals []string `json:"vals" toon:"vals"`
}

RUMErrorIngestionFilterCondition is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionHistoryItem added in v0.10.0 

type RUMErrorIngestionHistoryItem struct {
	// The application's complete rule list as of this version.
	Rules []RUMErrorIngestionRuleSnapshotItem `json:"rules" toon:"rules"`
	// Unix timestamp in milliseconds when this snapshot was recorded.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
	// Member ID whose action triggered this snapshot.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
	// Display name of the member whose action triggered this snapshot.
	UpdatedByName string `json:"updated_by_name" toon:"updated_by_name"`
	// History version number, incrementing from 1.
	Version int64 `json:"version" toon:"version"`
}

RUMErrorIngestionHistoryItem is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionHistoryListRequest added in v0.10.0 

type RUMErrorIngestionHistoryListRequest struct {
	ListOptions
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Sort ascending instead of the default descending order.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Sort column: `updated_at` or `version`. Unrecognized values fall back to `updated_at`.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
}

RUMErrorIngestionHistoryListRequest is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionHistoryListResponse added in v0.10.0 

type RUMErrorIngestionHistoryListResponse struct {
	// Whether another page of history exists after this one.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// History snapshots, ordered by `orderby`/`asc`.
	Items []RUMErrorIngestionHistoryItem `json:"items" toon:"items"`
	// Total number of history versions for the application.
	Total int64 `json:"total" toon:"total"`
}

RUMErrorIngestionHistoryListResponse is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionListRequest added in v0.10.0 

type RUMErrorIngestionListRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
}

RUMErrorIngestionListRequest is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionListResponse added in v0.10.0 

type RUMErrorIngestionListResponse struct {
	// Rules, newest-created first.
	Items []RUMErrorIngestionRule `json:"items" toon:"items"`
}

RUMErrorIngestionListResponse is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionOrFilters added in v0.10.0 

type RUMErrorIngestionOrFilters [][]RUMErrorIngestionFilterCondition

RUMErrorIngestionOrFilters is a list response payload.

type RUMErrorIngestionRevertRequest added in v0.10.0 

type RUMErrorIngestionRevertRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// History version number to revert to. Get versions via `POST /rum/error-ingestion/rules/history/list`.
	Version int64 `json:"version" toon:"version"`
}

RUMErrorIngestionRevertRequest is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionRule added in v0.10.0 

type RUMErrorIngestionRule struct {
	// Unix timestamp in milliseconds when the rule was created.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Rule description, up to 512 characters.
	Description string `json:"description" toon:"description"`
	// The rule's filter conditions.
	Filters RUMErrorIngestionOrFilters `json:"filters" toon:"filters"`
	// Rule ID.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name, 1-128 characters. Not required to be unique within the application.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Current status of the rule.
	Status string `json:"status" toon:"status"`
	// Unix timestamp in milliseconds when the rule was last updated.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
}

RUMErrorIngestionRule is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionRuleIDRequest added in v0.10.0 

type RUMErrorIngestionRuleIDRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Rule ID. Get rule IDs via `POST /rum/error-ingestion/rules/list`.
	RuleID string `json:"rule_id" toon:"rule_id"`
}

RUMErrorIngestionRuleIDRequest is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionRuleSnapshotItem added in v0.10.0 

type RUMErrorIngestionRuleSnapshotItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// RUM application ID the rule belongs to.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Unix timestamp in milliseconds when the row was created.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Member ID who created the rule.
	CreatedBy int64 `json:"created_by" toon:"created_by"`
	// Unix timestamp in milliseconds when the row was soft-deleted; `0` when not deleted.
	DeletedAt TimestampMilli `json:"deleted_at" toon:"deleted_at"`
	// Rule description.
	Description string `json:"description" toon:"description"`
	// The rule's filter conditions as of this snapshot version.
	Filters RUMErrorIngestionOrFilters `json:"filters" toon:"filters"`
	// Internal row ID.
	ID int64 `json:"id" toon:"id"`
	// Rule ID.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// The rule's status as of this snapshot version.
	Status string `json:"status" toon:"status"`
	// Unix timestamp in milliseconds when the row was last updated.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
	// Member ID who last updated the rule.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

RUMErrorIngestionRuleSnapshotItem is generated from the Flashduty OpenAPI schema.

type RUMErrorIngestionUpdateRequest added in v0.10.0 

type RUMErrorIngestionUpdateRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// New rule description, up to 512 characters. Omit to leave unchanged.
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// New filter conditions. Omit to leave unchanged.
	Filters RUMErrorIngestionOrFilters `json:"filters,omitempty" toon:"filters,omitempty"`
	// Rule ID to update. Get rule IDs via `POST /rum/error-ingestion/rules/list`.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// New rule name, 1-128 characters. Omit to leave unchanged.
	RuleName *string `json:"rule_name,omitempty" toon:"rule_name,omitempty"`
}

RUMErrorIngestionUpdateRequest is generated from the Flashduty OpenAPI schema.

type RUMFacetCountRequest added in v0.5.4 

type RUMFacetCountRequest struct {
	// RUM DQL filter expression applied before counting.
	Dql string `json:"dql,omitempty" toon:"dql,omitempty"`
	// End of the time range, Unix epoch milliseconds. Maximum 31-day span.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// Field key whose value distribution to count; must be a registered field of the given `scope`. List available fields via `POST /rum/field/list`.
	FacetKey string `json:"facet_key" toon:"facet_key"`
	// When set, filter events where `facet_key` equals this value before counting. Accepts string, number, or boolean.
	FacetValue any `json:"facet_value,omitempty" toon:"facet_value,omitempty"`
	// Symbol kind, used only when `scope` is `sourcemap` and only meaningful for `android`/`harmony`: `mapping` (default) selects ProGuard/R8 mappings or ArkTS sourcemaps, `native` selects native .so symbols.
	Kind string `json:"kind,omitempty" toon:"kind,omitempty"`
	// Maximum number of top values to return. Default 100, maximum 100.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
	// RUM data scope to query. One of:
	//
	// | Value | Meaning |
	// |---|---|
	// | `session` | User sessions |
	// | `view` | Page views |
	// | `action` | User actions |
	// | `error` | Error events |
	// | `resource` | Resource loads |
	// | `long_task` | Long tasks |
	// | `vital` | Performance vitals (Web Vitals, etc.) |
	// | `issue` | Aggregated error-tracking issues |
	// | `sourcemap` | Sourcemap / symbol files |
	Scope string `json:"scope" toon:"scope"`
	// SQL WHERE clause (no SELECT) for additional filtering.
	Sql string `json:"sql,omitempty" toon:"sql,omitempty"`
	// Start of the time range, Unix epoch milliseconds.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Symbol-store platform, used only when `scope` is `sourcemap`. Defaults to `browser` when omitted; `web` and `javascript` are accepted aliases of `browser`.
	//
	// | Value | Store queried |
	// |---|---|
	// | `browser` / `web` / `javascript` | JavaScript sourcemaps (excluding HarmonyOS ArkTS and React Native rows) |
	// | `android` | Android ProGuard/R8 mappings; with `kind=native`, Android NDK .so symbols |
	// | `ios` | iOS dSYM symbols |
	// | `miniprogram` | WeChat mini program sourcemaps |
	// | `harmony` | HarmonyOS ArkTS sourcemaps; with `kind=native`, HarmonyOS .so symbols |
	// | `flutter` | Flutter Dart AOT symbols |
	// | `electron` | Electron Breakpad symbols |
	// | `react-native` | React Native JS sourcemaps |
	Type string `json:"type,omitempty" toon:"type,omitempty"`
}

RUMFacetCountRequest is generated from the Flashduty OpenAPI schema.

type RUMFacetCountResponse added in v0.5.4 

type RUMFacetCountResponse struct {
	// Facet values with their occurrence counts, sorted by count descending, capped at `limit` (max 100).
	Items []FacetCountItem `json:"items" toon:"items"`
}

RUMFacetCountResponse is generated from the Flashduty OpenAPI schema.

type RUMFieldItem added in v0.5.4 

type RUMFieldItem struct {
	// Account ID. 0 for built-in fields.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Description of what this field captures.
	Description string `json:"description" toon:"description"`
	// True if this is a custom field that can be edited by the user.
	EditAble bool `json:"edit_able" toon:"edit_able"`
	// Predefined enumerable values for this field. Element type matches the field's `value_type`: string for `string`, number for `number`, boolean for `boolean`. Empty when the field has no fixed set of values.
	EnumValues []any `json:"enum_values" toon:"enum_values"`
	// Unique field key, e.g. `error.type`.
	FieldKey string `json:"field_key" toon:"field_key"`
	// Human-readable field name.
	FieldName string `json:"field_name" toon:"field_name"`
	// Display group for this field.
	Group string `json:"group" toon:"group"`
	// True if value distribution counting is supported for this field.
	IsFacet bool `json:"is_facet" toon:"is_facet"`
	// True if this field can be used in DQL/SQL queries.
	Queryable bool `json:"queryable" toon:"queryable"`
	// RUM scopes this field appears in.
	Scopes []string `json:"scopes" toon:"scopes"`
	// Display type in the analytics UI. One of `list` (shown as an enumerated value list; only this type supports facet counting) or `range` (filtered and shown as a numeric/time range).
	ShowType string `json:"show_type" toon:"show_type"`
	// Field status, e.g. `active`.
	Status string `json:"status" toon:"status"`
	// Measurement unit family, e.g. `time`, `bytes`. Empty for dimensionless fields.
	UnitFamily string `json:"unit_family" toon:"unit_family"`
	// Specific measurement unit, e.g. `millisecond`, `byte`.
	UnitName string `json:"unit_name" toon:"unit_name"`
	// Data type of the field value. One of:
	//
	// | Value | Meaning |
	// |---|---|
	// | `string` | String |
	// | `number` | Numeric |
	// | `boolean` | Boolean |
	// | `array<string>` | Array of strings |
	// | `array<number>` | Array of numbers |
	// | `array<boolean>` | Array of booleans |
	ValueType string `json:"value_type" toon:"value_type"`
}

RUMFieldItem is generated from the Flashduty OpenAPI schema.

type RUMFieldListRequest added in v0.5.4 

type RUMFieldListRequest struct {
	// When omitted or `null`, return all fields. When `true`, return only facet-enabled fields. When `false`, return only fields that are not facet-enabled.
	IsFacet *bool `json:"is_facet,omitempty" toon:"is_facet,omitempty"`
	// Filter by RUM data scopes; unknown values are rejected with a parameter error. Omit to list fields of all scopes.
	//
	// | Value | Meaning |
	// |---|---|
	// | `session` | User sessions |
	// | `view` | Page views |
	// | `action` | User actions |
	// | `error` | Error events |
	// | `resource` | Resource loads |
	// | `long_task` | Long tasks |
	// | `vital` | Performance vitals (Web Vitals, etc.) |
	// | `issue` | Aggregated error-tracking issues |
	// | `sourcemap` | Sourcemap / symbol files |
	Scopes []string `json:"scopes,omitempty" toon:"scopes,omitempty"`
}

RUMFieldListRequest is generated from the Flashduty OpenAPI schema.

type RUMFieldListResponse added in v0.5.4 

type RUMFieldListResponse struct {
	// RUM field definitions matching the `scopes` / `is_facet` filters, with names and descriptions localized to the request locale.
	Items []RUMFieldItem `json:"items" toon:"items"`
}

RUMFieldListResponse is generated from the Flashduty OpenAPI schema.

type RUMIssueExportRequest added in v0.14.3 

type RUMIssueExportRequest struct {
	ListOptions
	// Filter by application IDs. Get IDs via `POST /rum/application/list`.
	ApplicationIDs []string `json:"application_ids,omitempty" toon:"application_ids,omitempty"`
	// Sort ascending when `true`; descending by default.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// When `true`, match by time-range overlap: export issues still active within the window (`last_seen_timestamp` >= `start_time`) even if created before it. Default `false` exports only issues created inside the window.
	ByIntersection bool `json:"by_intersection,omitempty" toon:"by_intersection,omitempty"`
	// Console origin used to build the `issue_url` column, e.g. `https://console.flashcat.cloud`. The service cannot infer it (SaaS, on-premises and dev releases answer on different origins).
	ConsoleOrigin string `json:"console_origin,omitempty" toon:"console_origin,omitempty"`
	// DQL query for advanced filtering. Cannot be used with `sql`.
	Dql string `json:"dql,omitempty" toon:"dql,omitempty"`
	// End of the time range, Unix epoch milliseconds. Must be greater than `start_time`; maximum range: 183 days.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// If `true`, only export issues with at least one associated error event.
	ErrorRequired bool `json:"error_required,omitempty" toon:"error_required,omitempty"`
	// CSV columns to export, in the order they appear. Unknown keys are rejected with a parameter error; an empty array uses the default column set.
	//
	// | Value | Column content |
	// |---|---|
	// | `issue_id` | Issue ID |
	// | `issue_url` | Console URL of the issue detail page (built from `console_origin`) |
	// | `application_name` | Owning application name |
	// | `service` | Service name |
	// | `error_type` | Error type |
	// | `error_message` | Error message |
	// | `status` | Triage status |
	// | `severity` | Severity |
	// | `is_crash` | Whether the error caused a crash |
	// | `error_count` | Error occurrence count |
	// | `session_count` | Affected session count |
	// | `first_seen_at` | First occurrence time (rendered in `time_zone`) |
	// | `first_seen_version` | Application version at first occurrence |
	// | `last_seen_at` | Most recent occurrence time (rendered in `time_zone`) |
	// | `last_seen_version` | Application version at the most recent occurrence |
	// | `versions` | All affected versions |
	// | `suspected_cause` | Suspected cause category |
	// | `resolved_at` | Resolution time (rendered in `time_zone`) |
	ExportFields []string `json:"export_fields,omitempty" toon:"export_fields,omitempty"`
	// Sort field; defaults to `updated_at` when omitted.
	//
	// | Value | Meaning |
	// |---|---|
	// | `created_at` | Issue creation time |
	// | `updated_at` | Last update time |
	// | `session_count` | Affected session count |
	// | `error_count` | Error occurrence count |
	// | `severity` | Severity rank (`Critical` > `Warning` > `Info`) |
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// SQL-style query for advanced filtering. Cannot be used with `dql`.
	Sql string `json:"sql,omitempty" toon:"sql,omitempty"`
	// Start of the time range, Unix epoch milliseconds.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Filter by triage status; any other value is rejected with a parameter error.
	//
	// | Value | Meaning |
	// |---|---|
	// | `for_review` | Pending triage |
	// | `reviewed` | Reviewed |
	// | `ignored` | Ignored |
	// | `resolved` | Resolved |
	Statuses []string `json:"statuses,omitempty" toon:"statuses,omitempty"`
	// Filter by suspected cause category.
	//
	// | Value | Meaning |
	// |---|---|
	// | `api.failed_request` | API request failure (e.g. HTTP 4xx/5xx responses) |
	// | `network.error` | Network connectivity error (offline, aborted requests, etc.) |
	// | `code.exception` | Code exception (Syntax/Reference/Range and similar runtime errors) |
	// | `code.invalid_object_access` | Invalid object access (e.g. reading a property of `undefined`/`null`) |
	// | `code.invalid_argument` | Invalid argument passed to a function |
	// | `unknown` | Cause could not be determined |
	SuspectedCauses []string `json:"suspected_causes,omitempty" toon:"suspected_causes,omitempty"`
	// Filter by team IDs. Get team IDs via `POST /team/list`.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
	// IANA time zone used to render timestamps in the CSV, e.g. `Asia/Shanghai` or `UTC`. Default: `Asia/Shanghai`.
	TimeZone string `json:"time_zone,omitempty" toon:"time_zone,omitempty"`
}

RUMIssueExportRequest is generated from the Flashduty OpenAPI schema.

type RUMIssueIDRequest 

type RUMIssueIDRequest struct {
	// Issue ID. Get issue IDs via `POST /rum/issue/list`.
	IssueID string `json:"issue_id" toon:"issue_id"`
}

RUMIssueIDRequest is generated from the Flashduty OpenAPI schema.

type RUMIssueItem 

type RUMIssueItem struct {
	// Time span between the first and most recent occurrence, in seconds.
	Age int64 `json:"age" toon:"age"`
	// ID of the RUM application this issue belongs to.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Name of the owning application, resolved by `application_id` at query time (reflects the application's current name).
	ApplicationName string `json:"application_name" toon:"application_name"`
	// Issue creation time (client time of the first error event), Unix timestamp in milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Representative error of this issue, taken from the error event that created it.
	Error RUMIssueItemError `json:"error" toon:"error"`
	// Total error occurrences.
	ErrorCount int64 `json:"error_count" toon:"error_count"`
	// Information about the issue's first occurrence (time and application version).
	FirstSeen RUMIssueItemFirstSeen `json:"first_seen" toon:"first_seen"`
	// Whether the error caused an app crash.
	IsCrash bool `json:"is_crash" toon:"is_crash"`
	// Unique issue ID.
	IssueID string `json:"issue_id" toon:"issue_id"`
	// Information about the issue's most recent occurrence (time and application version).
	LastSeen RUMIssueItemLastSeen `json:"last_seen" toon:"last_seen"`
	// Regression metadata. Present only when a previously resolved issue re-occurred.
	Regression RUMIssueItemRegression `json:"regression" toon:"regression"`
	// Time the issue was marked resolved, Unix timestamp in milliseconds; 0 while unresolved.
	ResolvedAt TimestampMilli `json:"resolved_at" toon:"resolved_at"`
	// Person ID of the user who marked the issue resolved; 0 while unresolved.
	ResolvedBy int64 `json:"resolved_by" toon:"resolved_by"`
	// Name of the service that produced this issue, taken from the error event's `service` field.
	Service string `json:"service" toon:"service"`
	// Affected user sessions.
	SessionCount int64 `json:"session_count" toon:"session_count"`
	// Issue severity: `Critical`, `Warning`, or `Info`. Empty string on legacy issues created before severity existed.
	Severity string `json:"severity" toon:"severity"`
	// Triage status of the issue; soft-deleted (`deleted`) issues are never returned.
	//
	// | Value | Meaning |
	// |---|---|
	// | `for_review` | Pending triage |
	// | `reviewed` | Reviewed |
	// | `ignored` | Ignored |
	// | `resolved` | Resolved |
	Status string `json:"status" toon:"status"`
	// Suspected root cause analysis, determined automatically (rules or AI) or set manually by a user.
	SuspectedCause RUMIssueItemSuspectedCause `json:"suspected_cause" toon:"suspected_cause"`
	// ID of the team owning this issue, copied from the owning application's `team_id` at issue creation.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Time the issue was last updated, Unix timestamp in milliseconds.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
	// Deduplicated list of application versions in which this issue has occurred; may contain an empty string for events without version info.
	Versions []string `json:"versions" toon:"versions"`
}

RUMIssueItem is generated from the Flashduty OpenAPI schema.

type RUMIssueItemError 

type RUMIssueItemError struct {
	// Normalized error message, truncated to at most 512 characters.
	Message string `json:"message" toon:"message"`
	// Error type, from the error event's `error_type` field as reported by the SDK.
	Type string `json:"type" toon:"type"`
}

RUMIssueItemError is generated from the Flashduty OpenAPI schema.

type RUMIssueItemFirstSeen 

type RUMIssueItemFirstSeen struct {
	// Client time of the first error event, Unix timestamp in milliseconds.
	Timestamp TimestampMilli `json:"timestamp" toon:"timestamp"`
	// Application version at first occurrence; empty string when the event carries no version.
	Version string `json:"version" toon:"version"`
}

RUMIssueItemFirstSeen is generated from the Flashduty OpenAPI schema.

type RUMIssueItemLastSeen 

type RUMIssueItemLastSeen struct {
	// Client time of the most recent error event, Unix timestamp in milliseconds.
	Timestamp TimestampMilli `json:"timestamp" toon:"timestamp"`
	// Application version at the most recent occurrence; empty string when the event carries no version.
	Version string `json:"version" toon:"version"`
}

RUMIssueItemLastSeen is generated from the Flashduty OpenAPI schema.

type RUMIssueItemRegression 

type RUMIssueItemRegression struct {
	// Time the regression was detected, Unix timestamp in milliseconds.
	RegressedAt TimestampMilli `json:"regressed_at" toon:"regressed_at"`
	// Application version in which the regression was observed.
	RegressedAtVersion string `json:"regressed_at_version" toon:"regressed_at_version"`
	// When the issue was resolved before this regression, as a Unix timestamp in milliseconds.
	ResolvedAt TimestampMilli `json:"resolved_at" toon:"resolved_at"`
}

RUMIssueItemRegression is generated from the Flashduty OpenAPI schema.

type RUMIssueItemSuspectedCause 

type RUMIssueItemSuspectedCause struct {
	// Person ID of the user who manually set the cause; 0 when `source` is `auto`.
	PersonID int64 `json:"person_id" toon:"person_id"`
	// Explanation for the cause determination, generated only by AI analysis; empty string when AI is disabled or analysis has not run.
	Reason string `json:"reason" toon:"reason"`
	// Origin of the cause: `auto` for system-determined, `user` for manually set.
	Source string `json:"source" toon:"source"`
	// Suspected cause category. One of:
	//
	// | Value | Meaning |
	// |---|---|
	// | `api.failed_request` | API request failure (e.g. HTTP 4xx/5xx responses) |
	// | `network.error` | Network connectivity error (offline, aborted requests, etc.) |
	// | `code.exception` | Code exception (Syntax/Reference/Range and similar runtime errors) |
	// | `code.invalid_object_access` | Invalid object access (e.g. reading a property of `undefined`/`null`) |
	// | `code.invalid_argument` | Invalid argument passed to a function |
	// | `unknown` | Cause could not be determined |
	Value string `json:"value" toon:"value"`
}

RUMIssueItemSuspectedCause is generated from the Flashduty OpenAPI schema.

type RUMIssueListRequest 

type RUMIssueListRequest struct {
	ListOptions
	// Filter by application IDs. Get IDs via `POST /rum/application/list`.
	ApplicationIDs []string `json:"application_ids,omitempty" toon:"application_ids,omitempty"`
	// Sort ascending when `true`; descending by default.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// When `true`, match by time-range overlap: return issues still active within the window (`last_seen_timestamp` >= `start_time`) even if created before it. Default `false` returns only issues created inside the window.
	ByIntersection bool `json:"by_intersection,omitempty" toon:"by_intersection,omitempty"`
	// DQL query for advanced filtering. Cannot be used with `sql`.
	Dql string `json:"dql,omitempty" toon:"dql,omitempty"`
	// End of the time range, Unix epoch milliseconds. Must be greater than `start_time`; maximum range: 183 days.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// If `true`, only return issues with at least one associated error event.
	ErrorRequired bool `json:"error_required,omitempty" toon:"error_required,omitempty"`
	// Sort field; defaults to `updated_at` when omitted.
	//
	// | Value | Meaning |
	// |---|---|
	// | `created_at` | Issue creation time |
	// | `updated_at` | Last update time |
	// | `session_count` | Affected session count |
	// | `error_count` | Error occurrence count |
	// | `severity` | Severity rank (`Critical` > `Warning` > `Info`) |
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// SQL-style query for advanced filtering. Cannot be used with `dql`.
	Sql string `json:"sql,omitempty" toon:"sql,omitempty"`
	// Start of the time range, Unix epoch milliseconds.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Filter by triage status; any other value is rejected with a parameter error.
	//
	// | Value | Meaning |
	// |---|---|
	// | `for_review` | Pending triage |
	// | `reviewed` | Reviewed |
	// | `ignored` | Ignored |
	// | `resolved` | Resolved |
	Statuses []string `json:"statuses,omitempty" toon:"statuses,omitempty"`
	// Filter by suspected cause category.
	//
	// | Value | Meaning |
	// |---|---|
	// | `api.failed_request` | API request failure (e.g. HTTP 4xx/5xx responses) |
	// | `network.error` | Network connectivity error (offline, aborted requests, etc.) |
	// | `code.exception` | Code exception (Syntax/Reference/Range and similar runtime errors) |
	// | `code.invalid_object_access` | Invalid object access (e.g. reading a property of `undefined`/`null`) |
	// | `code.invalid_argument` | Invalid argument passed to a function |
	// | `unknown` | Cause could not be determined |
	SuspectedCauses []string `json:"suspected_causes,omitempty" toon:"suspected_causes,omitempty"`
	// Filter by team IDs. Get team IDs via `POST /team/list`.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

RUMIssueListRequest is generated from the Flashduty OpenAPI schema.

type RUMIssueListResponse 

type RUMIssueListResponse struct {
	// Whether more pages exist; `true` when matching records remain beyond the current page.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Issues of the current page.
	Items []RUMIssueItem `json:"items" toon:"items"`
	// Total number of issues matching the filter conditions.
	Total int64 `json:"total" toon:"total"`
}

RUMIssueListResponse is generated from the Flashduty OpenAPI schema.

type RUMIssueUpdateRequest 

type RUMIssueUpdateRequest struct {
	// Issue ID to update. Get issue IDs via `POST /rum/issue/list`.
	IssueID string `json:"issue_id" toon:"issue_id"`
	// New status. Setting `resolved` records the resolution time and operator; switching away from `resolved` clears them.
	//
	// | Value | Meaning |
	// |---|---|
	// | `for_review` | Pending triage |
	// | `reviewed` | Reviewed |
	// | `ignored` | Ignored |
	// | `resolved` | Resolved |
	Status string `json:"status,omitempty" toon:"status,omitempty"`
	// New suspected cause; setting it marks the cause source as `user`, overriding the automatic classification. One of:
	//
	// | Value | Meaning |
	// |---|---|
	// | `api.failed_request` | API request failure |
	// | `network.error` | Network connectivity error |
	// | `code.exception` | Code exception |
	// | `code.invalid_object_access` | Invalid object access |
	// | `code.invalid_argument` | Invalid argument |
	// | `unknown` | Unknown cause |
	SuspectedCause string `json:"suspected_cause,omitempty" toon:"suspected_cause,omitempty"`
}

RUMIssueUpdateRequest is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleCreateRequest added in v0.10.0 

type RUMPresetSeverityRuleCreateRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Optional description, up to 512 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// OR-of-ANDs filter structure: the outer array is OR'd, each inner array is AND'd. A rule matches an error when at least one inner AND-group fully matches.
	Filters [][]RUMPresetSeverityRuleFilterCondition `json:"filters" toon:"filters"`
	// Rule display name, 1-128 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Severity to assign to errors matching this rule.
	Severity string `json:"severity" toon:"severity"`
}

RUMPresetSeverityRuleCreateRequest is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleCreateResponse added in v0.10.0 

type RUMPresetSeverityRuleCreateResponse struct {
	// Evaluation order assigned to the new rule (always the current lowest precedence, i.e. current max + 1).
	Priority int64 `json:"priority" toon:"priority"`
	// ID of the newly created rule.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Echo of the rule's display name.
	RuleName string `json:"rule_name" toon:"rule_name"`
}

RUMPresetSeverityRuleCreateResponse is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleFilterCondition added in v0.10.0 

type RUMPresetSeverityRuleFilterCondition struct {
	// Filter attribute key. Only these Error-level attributes are supported for preset severity rules.
	//
	// | Value | Meaning |
	// |---|---|
	// | `error.usr_id` | User ID |
	// | `error.usr_email` | User email |
	// | `error.view_url` | Full URL of the page where the error occurred |
	// | `error.view_url_path` | URL path of the page where the error occurred |
	// | `error.error_type` | Error type |
	// | `error.error_message` | Error message |
	// | `error.env` | Environment (e.g. production/staging) |
	// | `error.service` | Service name |
	// | `error.device_type` | Device type |
	// | `error.os_name` | Operating system name |
	// | `error.browser_name` | Browser name |
	// | `error.is_crash` | Whether the error is a crash (boolean) |
	Key string `json:"key" toon:"key"`
	// Match semantics: `IN` matches when the field's value matches any of `vals`; `NOTIN` matches when it matches none of them (and matches when the field is absent).
	Oper string `json:"oper" toon:"oper"`
	// Values to match against. Each entry supports exact string match, wildcard (`*`/`?`), regex (wrap in `/.../`), CIDR (`cidr:10.0.0.0/8`) for IP-shaped values, or numeric comparison (`num:gt:100`, `num:le:50`, etc.).
	Vals []string `json:"vals" toon:"vals"`
}

RUMPresetSeverityRuleFilterCondition is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleHistoryItem added in v0.10.0 

type RUMPresetSeverityRuleHistoryItem struct {
	// Full rule set captured immediately before the mutation that produced this snapshot. Empty for the very first snapshot.
	Rules []RUMPresetSeverityRuleHistorySnapshotRule `json:"rules" toon:"rules"`
	// Unix timestamp in milliseconds when the snapshot was written.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
	// Member ID who triggered the mutation this snapshot precedes.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
	// Display name of `updated_by` at the time of the change.
	UpdatedByName string `json:"updated_by_name" toon:"updated_by_name"`
	// Monotonically increasing snapshot version number, starting at 1.
	Version int64 `json:"version" toon:"version"`
}

RUMPresetSeverityRuleHistoryItem is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleHistoryListRequest added in v0.10.0 

type RUMPresetSeverityRuleHistoryListRequest struct {
	ListOptions
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Sort ascending when true; results are descending by default.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Sort column. Any other value (including omitted) falls back to `updated_at`.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
}

RUMPresetSeverityRuleHistoryListRequest is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleHistoryListResponse added in v0.10.0 

type RUMPresetSeverityRuleHistoryListResponse struct {
	// Whether another page is available after this one.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Preset severity rule history snapshots of the current page.
	Items []RUMPresetSeverityRuleHistoryItem `json:"items" toon:"items"`
	// Total number of history snapshots for the application.
	Total int64 `json:"total" toon:"total"`
}

RUMPresetSeverityRuleHistoryListResponse is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleHistoryRevertRequest added in v0.10.0 

type RUMPresetSeverityRuleHistoryRevertRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Snapshot version number to revert to. Get versions via `POST /rum/issue/preset-severity/rules/history/list`.
	Version int64 `json:"version" toon:"version"`
}

RUMPresetSeverityRuleHistoryRevertRequest is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleHistorySnapshotRule added in v0.10.0 

type RUMPresetSeverityRuleHistorySnapshotRule struct {
	// Account ID the rule belongs to.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// RUM application ID the rule belongs to.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Unix timestamp in milliseconds when the rule was created.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Member ID who originally created the rule.
	CreatedBy int64 `json:"created_by" toon:"created_by"`
	// Unix timestamp in milliseconds the rule was soft-deleted; `0` means not deleted. Always `0` in practice, since deleted rules are excluded before a snapshot is taken.
	DeletedAt TimestampMilli `json:"deleted_at" toon:"deleted_at"`
	// Rule description. May be empty.
	Description string `json:"description" toon:"description"`
	// OR-of-ANDs filter structure: the outer array is OR'd, each inner array is AND'd. A rule matches an error when at least one inner AND-group fully matches.
	Filters [][]RUMPresetSeverityRuleFilterCondition `json:"filters" toon:"filters"`
	// Internal auto-increment row ID. Not stable across a history revert — reverting reinserts rows with new IDs.
	ID int64 `json:"id" toon:"id"`
	// Evaluation order at snapshot time; `1` is highest precedence.
	Priority int64 `json:"priority" toon:"priority"`
	// Unique rule ID.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule display name.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Severity assigned to errors matching this rule.
	Severity string `json:"severity" toon:"severity"`
	// Rule status at snapshot time.
	Status string `json:"status" toon:"status"`
	// Unix timestamp in milliseconds when the rule was last updated.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
	// Member ID who last updated the rule as of snapshot time.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

RUMPresetSeverityRuleHistorySnapshotRule is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleIDRequest added in v0.10.0 

type RUMPresetSeverityRuleIDRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Rule ID. Get rule IDs via `POST /rum/issue/preset-severity/rules/list`.
	RuleID string `json:"rule_id" toon:"rule_id"`
}

RUMPresetSeverityRuleIDRequest is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleItem added in v0.10.0 

type RUMPresetSeverityRuleItem struct {
	// Unix timestamp in milliseconds when the rule was created.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Rule description. May be empty.
	Description string `json:"description" toon:"description"`
	// OR-of-ANDs filter structure: the outer array is OR'd, each inner array is AND'd. A rule matches an error when at least one inner AND-group fully matches.
	Filters [][]RUMPresetSeverityRuleFilterCondition `json:"filters" toon:"filters"`
	// Evaluation order among the application's rules. `1` is evaluated first (highest precedence); the first enabled rule whose filters match wins.
	Priority int64 `json:"priority" toon:"priority"`
	// Unique rule ID.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule display name.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Severity assigned to errors matching this rule.
	Severity string `json:"severity" toon:"severity"`
	// Only enabled rules are evaluated against incoming errors.
	Status string `json:"status" toon:"status"`
	// Unix timestamp in milliseconds when the rule was last updated.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
}

RUMPresetSeverityRuleItem is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleListRequest added in v0.10.0 

type RUMPresetSeverityRuleListRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
}

RUMPresetSeverityRuleListRequest is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleListResponse added in v0.10.0 

type RUMPresetSeverityRuleListResponse struct {
	// Rules ordered by evaluation order (`priority` ascending, then `created_at` ascending).
	Items []RUMPresetSeverityRuleItem `json:"items" toon:"items"`
}

RUMPresetSeverityRuleListResponse is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleReorderRequest added in v0.10.0 

type RUMPresetSeverityRuleReorderRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// ID of the rule being moved. Get rule IDs via `POST /rum/issue/preset-severity/rules/list`.
	DragRuleID string `json:"drag_rule_id" toon:"drag_rule_id"`
	// ID of the rule whose evaluation position `drag_rule_id` moves to.
	TargetRuleID string `json:"target_rule_id" toon:"target_rule_id"`
}

RUMPresetSeverityRuleReorderRequest is generated from the Flashduty OpenAPI schema.

type RUMPresetSeverityRuleUpdateRequest added in v0.10.0 

type RUMPresetSeverityRuleUpdateRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// New description, up to 512 characters. Omit to leave unchanged.
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// OR-of-ANDs filter structure: the outer array is OR'd, each inner array is AND'd. A rule matches an error when at least one inner AND-group fully matches.
	Filters [][]RUMPresetSeverityRuleFilterCondition `json:"filters,omitempty" toon:"filters,omitempty"`
	// Rule ID to update. Get rule IDs via `POST /rum/issue/preset-severity/rules/list`.
	RuleID string `json:"rule_id" toon:"rule_id"`
	// New display name, 1-128 characters. Omit to leave unchanged.
	RuleName *string `json:"rule_name,omitempty" toon:"rule_name,omitempty"`
	// New severity. Omit to leave unchanged.
	Severity *string `json:"severity,omitempty" toon:"severity,omitempty"`
}

RUMPresetSeverityRuleUpdateRequest is generated from the Flashduty OpenAPI schema.

type RUMReplayApplication added in v0.5.7 

type RUMReplayApplication struct {
	// RUM application ID the session belongs to.
	ID string `json:"id" toon:"id"`
}

RUMReplayApplication is generated from the Flashduty OpenAPI schema.

type RUMReplayDevice added in v0.5.7 

type RUMReplayDevice struct {
	// Device type recorded for the session, e.g. `desktop`, `mobile`, `tablet`.
	Type string `json:"type" toon:"type"`
}

RUMReplayDevice is generated from the Flashduty OpenAPI schema.

type RUMReplayForegroundPeriod added in v0.5.7 

type RUMReplayForegroundPeriod struct {
	// Unix timestamp in milliseconds when the foreground period ended.
	End TimestampMilli `json:"end" toon:"end"`
	// Unix timestamp in milliseconds when the foreground period started.
	Start TimestampMilli `json:"start" toon:"start"`
	// View ID active during this foreground period.
	ViewID string `json:"view_id" toon:"view_id"`
}

RUMReplayForegroundPeriod is generated from the Flashduty OpenAPI schema.

type RUMReplaySession added in v0.5.7 

type RUMReplaySession struct {
	// Unix timestamp in milliseconds when the session ended (or was last updated, if still active).
	End TimestampMilli `json:"end" toon:"end"`
	// Whether the session was still active as of the last recorded event.
	IsActive bool `json:"is_active" toon:"is_active"`
	// Clock skew in milliseconds between the client and Flashduty's servers, added to client timestamps for correction.
	ServerTimeDelta int64 `json:"server_time_delta" toon:"server_time_delta"`
	// SDK platform that recorded the session. Platform identifier:
	//
	// | Value | Meaning |
	// |---|---|
	// | `browser` | Web browser application (JavaScript SDK) |
	// | `ios` | Apple iOS application |
	// | `android` | Android application |
	// | `react-native` | React Native application |
	// | `flutter` | Flutter application |
	// | `kotlin-multiplatform` | Kotlin Multiplatform application |
	// | `roku` | Roku channel application |
	// | `unity` | Unity application |
	// | `miniprogram` | WeChat mini program |
	// | `harmony` | HarmonyOS application |
	// | `electron` | Electron desktop application |
	Source string `json:"source" toon:"source"`
	// Unix timestamp in milliseconds when the session started.
	Start TimestampMilli `json:"start" toon:"start"`
}

RUMReplaySession is generated from the Flashduty OpenAPI schema.

type RUMReplayView added in v0.5.7 

type RUMReplayView struct {
	// SDK platform of the container app, when this view is embedded (e.g. a WebView inside a native app). Omitted when the view is not embedded.
	ContainerSource string `json:"container_source" toon:"container_source"`
	// View ID of the containing view, when this view is embedded. Omitted when the view is not embedded.
	ContainerViewID string `json:"container_view_id" toon:"container_view_id"`
	// Unix timestamp in milliseconds when the view ended.
	End TimestampMilli `json:"end" toon:"end"`
	// Whether the view was still active as of the last recorded event.
	IsActive bool `json:"is_active" toon:"is_active"`
	// How the view was entered, e.g. `initial_load`, `route_change`.
	LoadingType string `json:"loading_type" toon:"loading_type"`
	// View name, typically the route or screen name.
	Name string `json:"name" toon:"name"`
	// Clock skew in milliseconds between the client and Flashduty's servers, added to client timestamps for correction.
	ServerTimeDelta int64 `json:"server_time_delta" toon:"server_time_delta"`
	// SDK platform that recorded the view. Platform identifier:
	//
	// | Value | Meaning |
	// |---|---|
	// | `browser` | Web browser application (JavaScript SDK) |
	// | `ios` | Apple iOS application |
	// | `android` | Android application |
	// | `react-native` | React Native application |
	// | `flutter` | Flutter application |
	// | `kotlin-multiplatform` | Kotlin Multiplatform application |
	// | `roku` | Roku channel application |
	// | `unity` | Unity application |
	// | `miniprogram` | WeChat mini program |
	// | `harmony` | HarmonyOS application |
	// | `electron` | Electron desktop application |
	Source string `json:"source" toon:"source"`
	// Unix timestamp in milliseconds when the view started.
	Start TimestampMilli `json:"start" toon:"start"`
	// URL (web) or screen identifier (mobile) associated with the view.
	URL string `json:"url" toon:"url"`
	// Unique ID of the view within the session.
	ViewID string `json:"view_id" toon:"view_id"`
}

RUMReplayView is generated from the Flashduty OpenAPI schema.

type RUMResourceInfoRequest added in v0.10.0 

type RUMResourceInfoRequest struct {
	// Bypass the short-lived cache of the resource record (plan version, quotas, status) and read it from source. Does not refresh the usage counts. Default `false`.
	NoCache bool `json:"no_cache,omitempty" toon:"no_cache,omitempty"`
}

RUMResourceInfoRequest is generated from the Flashduty OpenAPI schema.

type RUMResourceItem added in v0.10.0 

type RUMResourceItem struct {
	// Account ID that owns this resource.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Retention period in days for action (user interaction) data.
	ActionDays int64 `json:"action.days" toon:"action.days"`
	// Unix timestamp in seconds when the resource was created. Also anchors the start of the first billing window.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Retention period in days for error data.
	ErrorDays int64 `json:"error.days" toon:"error.days"`
	// Unix timestamp in seconds when the on-premises license expires. Only present on on-premises deployments; omitted entirely for SaaS accounts.
	ExpiredAt Timestamp `json:"expired_at" toon:"expired_at"`
	// Retention period in days for long-task data.
	LongTaskDays int64 `json:"long_task.days" toon:"long_task.days"`
	// ID of the offering (SKU) this resource was provisioned from.
	OfferingID int64 `json:"offering_id" toon:"offering_id"`
	// ID of the order that provisioned this resource. Empty for resources provisioned outside the order flow (e.g. on-premises).
	OrderID string `json:"order_id" toon:"order_id"`
	// Product code for this resource. Always `rum` for this endpoint.
	Product string `json:"product" toon:"product"`
	// Retention period in days for resource (network request) data.
	ResourceDays int64 `json:"resource.days" toon:"resource.days"`
	// Unique resource identifier for the account's RUM resource.
	ResourceID string `json:"resource_id" toon:"resource_id"`
	// Display name of the resource.
	ResourceName string `json:"resource_name" toon:"resource_name"`
	// Retention period in days for session data.
	SessionDays int64 `json:"session.days" toon:"session.days"`
	// Free quota for investigate sessions per application, per billing window.
	SessionInvestigateFreeCnt int64 `json:"session_investigate.free_cnt" toon:"session_investigate.free_cnt"`
	// Number of investigate (error tracking) sessions used in the current billing window.
	SessionInvestigateUsedCnt int64 `json:"session_investigate.used_cnt" toon:"session_investigate.used_cnt"`
	// `true` when a `version=free` account has exceeded its combined free session quota across all applications. Always `false` for non-free plans.
	SessionLimitReached bool `json:"session_limit_reached" toon:"session_limit_reached"`
	// Free quota for measure sessions per application, per billing window.
	SessionMeasureFreeCnt int64 `json:"session_measure.free_cnt" toon:"session_measure.free_cnt"`
	// Number of measure (performance) sessions used in the current billing window.
	SessionMeasureUsedCnt int64 `json:"session_measure.used_cnt" toon:"session_measure.used_cnt"`
	// Free quota for session-replay sessions per application, per billing window.
	SessionReplayFreeCnt int64 `json:"session_replay.free_cnt" toon:"session_replay.free_cnt"`
	// Number of session-replay sessions used in the current billing window.
	SessionReplayUsedCnt int64 `json:"session_replay.used_cnt" toon:"session_replay.used_cnt"`
	// Status of the resource. A resource with status `deleted` or `destroyed` never reaches this field — the operation returns `ResourceNotFound` for those instead.
	Status string `json:"status" toon:"status"`
	// Unix timestamp in seconds when the resource was last updated.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Plan version of this resource. One of `free` (free plan) or `professional` (professional plan).
	Version string `json:"version" toon:"version"`
	// Retention period in days for view (page/screen) data.
	ViewDays int64 `json:"view.days" toon:"view.days"`
	// Unix timestamp in seconds for the end of the current 30-day billing window.
	WindowEndTime Timestamp `json:"window_end_time" toon:"window_end_time"`
	// Unix timestamp in seconds for the start of the current 30-day billing window.
	WindowStartTime Timestamp `json:"window_start_time" toon:"window_start_time"`
}

RUMResourceItem is generated from the Flashduty OpenAPI schema.

type RUMSessionReplayMetaItem added in v0.5.7 

type RUMSessionReplayMetaItem struct {
	// Application the session belongs to.
	Application RUMReplayApplication `json:"application" toon:"application"`
	// Device that recorded the session.
	Device RUMReplayDevice `json:"device" toon:"device"`
	// Foreground periods across the session (mobile sessions only; empty for web).
	ForegroundPeriods []RUMReplayForegroundPeriod `json:"foreground_periods" toon:"foreground_periods"`
	// Session bounds and state.
	Session RUMReplaySession `json:"session" toon:"session"`
	// Every view recorded during the session, in chronological order.
	Views []RUMReplayView `json:"views" toon:"views"`
}

RUMSessionReplayMetaItem is generated from the Flashduty OpenAPI schema.

type RUMSessionReplayMetaRequest added in v0.5.7 

type RUMSessionReplayMetaRequest struct {
	// RUM session ID (the `session.id` attribute on RUM events).
	SessionID string `json:"session_id" toon:"session_id"`
	// Unix timestamp in milliseconds of the session start time. Optional; disambiguates when a session ID has been reused across different time windows.
	TS int64 `json:"ts,omitempty" toon:"ts,omitempty"`
}

RUMSessionReplayMetaRequest is generated from the Flashduty OpenAPI schema.

type RUMSessionReplaySegmentsRequest added in v0.5.7 

type RUMSessionReplaySegmentsRequest struct {
	// Maximum number of segments to return. 1-99, default 20.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
	// Pagination cursor from a previous call. Take it from the `search_after_ctx` field (URL mode) or the `X-Search-After-Ctx` response header (streaming mode).
	SearchAfterCtx string `json:"search_after_ctx,omitempty" toon:"search_after_ctx,omitempty"`
	// RUM session ID (the `session.id` attribute on RUM events).
	SessionID string `json:"session_id" toon:"session_id"`
	// Unix timestamp in milliseconds. When set (and `search_after_ctx` is empty), seeks to the most recent full-snapshot segment at or before this time instead of starting from the beginning.
	TS int64 `json:"ts,omitempty" toon:"ts,omitempty"`
	// When `true`, return presigned download URLs as a JSON envelope instead of streaming segment bytes. Defaults to `false`.
	URLMode bool `json:"url_mode,omitempty" toon:"url_mode,omitempty"`
	// Restrict results to segments belonging to this view. Omit to page through the entire session.
	ViewID string `json:"view_id,omitempty" toon:"view_id,omitempty"`
}

RUMSessionReplaySegmentsRequest is generated from the Flashduty OpenAPI schema.

type RUMSessionReplaySegmentsResult added in v0.5.7 

type RUMSessionReplaySegmentsResult struct {
	// Presigned, time-limited URLs (valid 1 hour) for downloading each segment's raw compressed bytes.
	Items []string `json:"items" toon:"items"`
	// Pagination cursor to pass as `search_after_ctx` on the next call. Empty when this page was the last one.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
}

RUMSessionReplaySegmentsResult is generated from the Flashduty OpenAPI schema.

type RUMWebhookTestRequest added in v0.5.4 

type RUMWebhookTestRequest struct {
	// RUM application ID. Get application IDs via `POST /rum/application/list`.
	ApplicationID string `json:"application_id" toon:"application_id"`
	// Webhook URL to receive the sample alert event.
	WebhookURL string `json:"webhook_url" toon:"webhook_url"`
}

RUMWebhookTestRequest is generated from the Flashduty OpenAPI schema.

type RUMWebhookTestResponse added in v0.5.4 

type RUMWebhookTestResponse struct {
	// `ok` on success, otherwise the delivery error message.
	Message string `json:"message" toon:"message"`
	// Whether the webhook endpoint accepted the sample event.
	OK bool `json:"ok" toon:"ok"`
	// HTTP status code returned by the webhook endpoint. 0 when the request did not receive a response.
	StatusCode int64 `json:"status_code" toon:"status_code"`
}

RUMWebhookTestResponse is generated from the Flashduty OpenAPI schema.

type RateLimit 

type RateLimit struct {
	Limit      int           // X-RateLimit-Limit, if present
	Remaining  int           // X-RateLimit-Remaining, if present
	Reset      time.Time     // X-RateLimit-Reset (unix seconds), if present
	RetryAfter time.Duration // Retry-After (delta-seconds), if present
}

RateLimit captures rate-limit signals parsed from a response, best-effort. Each field is zero when the server did not send the corresponding header.

type RateLimitError 

type RateLimitError struct {
	*ErrorResponse
	RetryAfter time.Duration
}

RateLimitError is returned when the API responds 429. It embeds the standard *ErrorResponse (so errors.As(err, &target) for a *ErrorResponse still works) and adds the Retry-After hint. Inspect it with errors.As(err, &target) for a *RateLimitError.

func (*RateLimitError) Error 

func (e *RateLimitError) Error() string

func (*RateLimitError) Unwrap 

func (e *RateLimitError) Unwrap() error

Unwrap lets errors.As reach the embedded *ErrorResponse.

type RemoveIncidentRequest 

type RemoveIncidentRequest struct {
	// Incident IDs to remove. At most 100 per call. The caller must have access to every channel the incidents belong to.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
}

RemoveIncidentRequest is generated from the Flashduty OpenAPI schema.

type ReopenIncidentRequest 

type ReopenIncidentRequest struct {
	// Incident IDs to reopen. At most 100 per call.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
	// Optional reason recorded on the timeline.
	Reason string `json:"reason,omitempty" toon:"reason,omitempty"`
}

ReopenIncidentRequest is generated from the Flashduty OpenAPI schema.

type ReorderIncidentCommentTypesRequest added in v0.8.0 

type ReorderIncidentCommentTypesRequest struct {
	// IDs of every comment type of the account in the desired order (24-character hex ObjectIDs).
	CommentTypeIDs []string `json:"comment_type_ids" toon:"comment_type_ids"`
}

ReorderIncidentCommentTypesRequest is generated from the Flashduty OpenAPI schema.

type ResetIncidentFieldRequest 

type ResetIncidentFieldRequest struct {
	// Custom field name; must match a field defined on the account.
	FieldName string `json:"field_name" toon:"field_name"`
	// New field value. Type must match the field definition.
	FieldValue any `json:"field_value,omitempty" toon:"field_value,omitempty"`
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
}

ResetIncidentFieldRequest is generated from the Flashduty OpenAPI schema.

type ResetPostMortemBasicsRequest added in v0.5.4 

type ResetPostMortemBasicsRequest struct {
	// Unix timestamp in seconds for the earliest linked incident start time.
	IncidentsEarliestStartSeconds int64 `json:"incidents_earliest_start_seconds" toon:"incidents_earliest_start_seconds"`
	// Highest severity among linked incidents: `Critical`, `Warning`, `Info`, or `Ok`.
	IncidentsHighestSeverity string `json:"incidents_highest_severity" toon:"incidents_highest_severity"`
	// Unix timestamp in seconds for the latest linked incident close time. 0 when still open.
	IncidentsLatestCloseSeconds int64 `json:"incidents_latest_close_seconds,omitempty" toon:"incidents_latest_close_seconds,omitempty"`
	// Total incident duration in seconds.
	IncidentsTotalDurationSeconds int64 `json:"incidents_total_duration_seconds,omitempty" toon:"incidents_total_duration_seconds,omitempty"`
	// Post-mortem ID; obtain it from `POST /incident/post-mortem/list`.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Responder member IDs to store on the report.
	ResponderIDs []int64 `json:"responder_ids,omitempty" toon:"responder_ids,omitempty"`
}

ResetPostMortemBasicsRequest is generated from the Flashduty OpenAPI schema.

type ResetPostMortemContentRequest added in v0.5.9 

type ResetPostMortemContentRequest struct {
	// Current content revision expected by the caller. Pass 0 for the first write to a document that has never been saved.
	ExpectedRevision *int64 `json:"expected_revision,omitempty" toon:"expected_revision,omitempty"`
	// Non-blank key for safely retrying this exact reset request.
	IdempotencyKey string `json:"idempotency_key" toon:"idempotency_key"`
	// Replacement Markdown content. Limited to 4 MiB.
	Markdown string `json:"markdown" toon:"markdown"`
	// ID of the post-mortem to reset; obtain it from `POST /incident/post-mortem/list`.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
}

ResetPostMortemContentRequest is generated from the Flashduty OpenAPI schema.

type ResetPostMortemFollowUpsRequest added in v0.5.4 

type ResetPostMortemFollowUpsRequest struct {
	// Follow-up action items as free text.
	FollowUps string `json:"follow_ups,omitempty" toon:"follow_ups,omitempty"`
	// Post-mortem ID; obtain it from `POST /incident/post-mortem/list`.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
}

ResetPostMortemFollowUpsRequest is generated from the Flashduty OpenAPI schema.

type ResetPostMortemStatusRequest added in v0.5.4 

type ResetPostMortemStatusRequest struct {
	// Post-mortem ID; obtain it from `POST /incident/post-mortem/list`.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Target report status: `drafting` draft, `published` published.
	Status string `json:"status" toon:"status"`
}

ResetPostMortemStatusRequest is generated from the Flashduty OpenAPI schema.

type ResetPostMortemTitleRequest added in v0.5.4 

type ResetPostMortemTitleRequest struct {
	// Post-mortem ID; obtain it from `POST /incident/post-mortem/list`.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// New report title.
	Title string `json:"title" toon:"title"`
}

ResetPostMortemTitleRequest is generated from the Flashduty OpenAPI schema.

type ResetWorkItemAssigneesRequest added in v0.8.0 

type ResetWorkItemAssigneesRequest struct {
	// New assignee member IDs, replacing the current set. An empty array clears all assignees.
	AssigneeIDs []int64 `json:"assignee_ids,omitempty" toon:"assignee_ids,omitempty"`
	// Current item version for optimistic locking. Must match the stored version.
	Version int64 `json:"version" toon:"version"`
	// Work item ID (opaque string, max 128 characters).
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

ResetWorkItemAssigneesRequest is generated from the Flashduty OpenAPI schema.

type ResolveIncidentRequest 

type ResolveIncidentRequest struct {
	// Custom field values for the resolution form. Allowed keys and values depend on the incident's visible form.
	CustomFields CustomFieldValues `json:"custom_fields,omitempty" toon:"custom_fields,omitempty"`
	// New incident description, up to 6,144 characters. When set, it replaces the current description before the incident closes.
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// Images attached to the resolution timeline entry.
	Images []IncidentActionImage `json:"images,omitempty" toon:"images,omitempty"`
	// Incident IDs to resolve. At most 100 per call.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
	// Optional resolution note applied to every resolved incident.
	Resolution *string `json:"resolution,omitempty" toon:"resolution,omitempty"`
	// Optional root cause note applied to every resolved incident.
	RootCause *string `json:"root_cause,omitempty" toon:"root_cause,omitempty"`
	// Form summary recorded as a timeline comment. Accepted only when the resolution form contains a summary element.
	Summary string `json:"summary,omitempty" toon:"summary,omitempty"`
}

ResolveIncidentRequest is generated from the Flashduty OpenAPI schema.

type ResourcesService added in v0.10.0 

type ResourcesService service

ResourcesService handles the "RUM/Resources" API resource.

func (*ResourcesService) Info added in v0.10.0 

func (s *ResourcesService) Info(ctx context.Context, req *RUMResourceInfoRequest) (*RUMResourceItem, *Response, error)

Get RUM resource info.

Return the account's RUM resource record and its current session usage.

API: POST /rum/resource/info (rum-resource-read-info).

type Responder 

type Responder struct {
	// Unix timestamp (seconds) when the member acknowledged. 0 if not yet acknowledged.
	AcknowledgedAt Timestamp `json:"acknowledged_at" toon:"acknowledged_at"`
	// Role label of this responder.
	As string `json:"as" toon:"as"`
	// Unix timestamp (seconds) when the member was assigned.
	AssignedAt Timestamp `json:"assigned_at" toon:"assigned_at"`
	// Member email, filled by the server.
	Email string `json:"email" toon:"email"`
	// Responder member ID.
	PersonID int64 `json:"person_id" toon:"person_id"`
	// Member display name, filled by the server.
	PersonName string `json:"person_name" toon:"person_name"`
}

Responder is generated from the Flashduty OpenAPI schema.

type ResponderInsightItem 

type ResponderInsightItem struct {
	// This responder's acknowledgement rate (%): acknowledged incidents ÷ involved incidents × 100, rounded to two decimals and capped at 100; 0 when the responder has no incidents.
	AcknowledgementPct float64 `json:"acknowledgement_pct" toon:"acknowledgement_pct"`
	// Channel ID, returned only when aggregating by channel (`/insight/channel`).
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel name, returned when aggregating by channel; omitted when the name cannot be resolved.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Hour bucket when `split_hours` is enabled. `work` is Mon–Fri 08:00–19:00, `sleep` is daily 23:00–08:00, and `off` is everything else, all evaluated in the account timezone (`sleep` takes precedence over `work`). Omitted when `split_hours` is false.
	Hours string `json:"hours" toon:"hours"`
	// This responder's mean time to acknowledgement in seconds; 0 when the responder acknowledged nothing.
	MeanSecondsToAck float64 `json:"mean_seconds_to_ack" toon:"mean_seconds_to_ack"`
	// Responder (person) ID, returned only when aggregating by responder (`/insight/responder`).
	ResponderID int64 `json:"responder_id" toon:"responder_id"`
	// Responder name, returned when aggregating by responder; omitted when the name cannot be resolved.
	ResponderName string `json:"responder_name" toon:"responder_name"`
	// Team ID, returned only when aggregating by team (`/insight/team`).
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Team name, returned when aggregating by team; omitted when the name cannot be resolved (e.g. team deleted).
	TeamName string `json:"team_name" toon:"team_name"`
	// This responder's total engaged time in seconds: each incident contributes close time minus their acknowledgement time.
	TotalEngagedSeconds int64 `json:"total_engaged_seconds" toon:"total_engaged_seconds"`
	// Incidents this responder was involved in.
	TotalIncidentCnt int64 `json:"total_incident_cnt" toon:"total_incident_cnt"`
	// Incidents acknowledged by this responder.
	TotalIncidentsAcknowledged int64 `json:"total_incidents_acknowledged" toon:"total_incidents_acknowledged"`
	// This responder's incidents that were escalated at least once.
	TotalIncidentsEscalated int64 `json:"total_incidents_escalated" toon:"total_incidents_escalated"`
	// This responder's incidents escalated manually.
	TotalIncidentsManuallyEscalated int64 `json:"total_incidents_manually_escalated" toon:"total_incidents_manually_escalated"`
	// Incidents reassigned away from this responder.
	TotalIncidentsReassigned int64 `json:"total_incidents_reassigned" toon:"total_incidents_reassigned"`
	// This responder's incidents escalated on timeout.
	TotalIncidentsTimeoutEscalated int64 `json:"total_incidents_timeout_escalated" toon:"total_incidents_timeout_escalated"`
	// Interruptions for this responder: notifications sent via app push, SMS, or voice call; consecutive notifications within 60 seconds count as one.
	TotalInterruptions int64 `json:"total_interruptions" toon:"total_interruptions"`
	// Total notifications sent to this responder.
	TotalNotifications int64 `json:"total_notifications" toon:"total_notifications"`
	// This responder's total time to acknowledgement in seconds: each incident contributes acknowledgement time minus assignment time.
	TotalSecondsToAck int64 `json:"total_seconds_to_ack" toon:"total_seconds_to_ack"`
	// Start of the aggregation bucket, Unix epoch seconds. Equals `start_time` when no `aggregate_unit` is given.
	TS Timestamp `json:"ts" toon:"ts"`
}

ResponderInsightItem is generated from the Flashduty OpenAPI schema.

type ResponderInsightResponse 

type ResponderInsightResponse struct {
	// Incident response metric rows aggregated by responder; further split by hour bucket or time bucket when `split_hours` or `aggregate_unit` is enabled.
	Items []ResponderInsightItem `json:"items" toon:"items"`
}

ResponderInsightResponse is generated from the Flashduty OpenAPI schema.

type Response 

type Response struct {
	*http.Response

	RequestID      string
	Total          int
	HasNextPage    bool
	SearchAfterCtx string
	RateLimit      RateLimit

	// Raw holds the response body for endpoints that return a non-JSON payload
	// on success (e.g. CSV/file downloads from the *export endpoints). It is nil
	// for normal JSON responses; the typed return value is then the zero value.
	Raw []byte
}

Response wraps http.Response and surfaces Flashduty envelope metadata: the request id (for support), pagination fields when the endpoint returns them, and best-effort rate-limit signals.

type ResponseEnvelope added in v0.4.0 

type ResponseEnvelope struct {
	// Endpoint-specific payload. See each operation's 200 response schema.
	Data  any `json:"data" toon:"data"`
	Error any `json:"error" toon:"error"`
	// Unique ID for this request. Mirrored in the Flashcat-Request-Id header. Include it when reporting issues.
	RequestID string `json:"request_id" toon:"request_id"`
}

ResponseEnvelope is generated from the Flashduty OpenAPI schema.

type RoleDeleteRequest added in v0.14.3 

type RoleDeleteRequest struct {
	// When false (default), deletion fails with a `ReferenceExist` error listing the members that still hold the role in `data.refs`. When true, the role is first revoked from all holders and then deleted.
	IsForce bool `json:"is_force,omitempty" toon:"is_force,omitempty"`
	// Role ID to delete. Get IDs from `POST /role/list` (built-in roles: 2=Admin, 6=Responder, 8=Viewer).
	RoleID uint64 `json:"role_id" toon:"role_id"`
}

RoleDeleteRequest is generated from the Flashduty OpenAPI schema.

type RoleGrantRequest 

type RoleGrantRequest struct {
	// Member IDs to grant/revoke the role.
	MemberIDs []uint64 `json:"member_ids" toon:"member_ids"`
	// Role ID to grant or revoke. Get IDs from `POST /role/list`.
	RoleID uint64 `json:"role_id" toon:"role_id"`
}

RoleGrantRequest is generated from the Flashduty OpenAPI schema.

type RoleIDRequest 

type RoleIDRequest struct {
	// Role ID to operate on. Get IDs from `POST /role/list` (built-in roles: 2=Admin, 6=Responder, 8=Viewer).
	RoleID uint64 `json:"role_id" toon:"role_id"`
}

RoleIDRequest is generated from the Flashduty OpenAPI schema.

type RoleInfoRequest 

type RoleInfoRequest struct {
	// Role ID to query. Get IDs from `POST /role/list` (built-in roles: 2=Admin, 6=Responder, 8=Viewer).
	RoleID uint64 `json:"role_id" toon:"role_id"`
}

RoleInfoRequest is generated from the Flashduty OpenAPI schema.

type RoleItem 

type RoleItem struct {
	// Unix epoch seconds the role was created.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Role description.
	Description string `json:"description" toon:"description"`
	// False for built-in roles which cannot be modified.
	Editable bool `json:"editable" toon:"editable"`
	// IDs of permissions granted by this role.
	PermissionIDs []uint64 `json:"permission_ids" toon:"permission_ids"`
	// Unique role ID.
	RoleID uint64 `json:"role_id" toon:"role_id"`
	// Role display name.
	RoleName string `json:"role_name" toon:"role_name"`
	// Role status.
	Status string `json:"status" toon:"status"`
	// Unix epoch seconds the role was last updated.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

RoleItem is generated from the Flashduty OpenAPI schema.

type RoleListRequest 

type RoleListRequest struct {
	// Ascending sort order. Default: false (descending).
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// When true, exclude the built-in global roles (Admin, Responder, Viewer) and return only custom roles. Default: false.
	NoGlobal bool `json:"no_global,omitempty" toon:"no_global,omitempty"`
	// Sort field. Default: `updated_at`.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
}

RoleListRequest is generated from the Flashduty OpenAPI schema.

type RoleListResponse 

type RoleListResponse struct {
	// Array of roles; includes account roles plus built-in global roles unless `no_global=true`; empty array when no results.
	Items []RoleItem `json:"items" toon:"items"`
	// Total role count.
	Total int64 `json:"total" toon:"total"`
}

RoleListResponse is generated from the Flashduty OpenAPI schema.

type RolePermissionListRequest 

type RolePermissionListRequest struct {
	// Filter to permissions granted to these roles.
	RoleIDs []uint64 `json:"role_ids,omitempty" toon:"role_ids,omitempty"`
	// If true, return all permissions with is_granted set to indicate which are granted.
	WithAll bool `json:"with_all,omitempty" toon:"with_all,omitempty"`
}

RolePermissionListRequest is generated from the Flashduty OpenAPI schema.

type RolePermissionListResponse 

type RolePermissionListResponse struct {
	// Array of permission items: system-level permissions plus the caller's account-scoped custom-menu permissions (never other tenants' rows).
	Items []PermissionItem `json:"items" toon:"items"`
}

RolePermissionListResponse is generated from the Flashduty OpenAPI schema.

type RoleUpsertRequest 

type RoleUpsertRequest struct {
	// Role description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Permission IDs to grant. Replaces the existing set.
	PermissionIDs []uint64 `json:"permission_ids,omitempty" toon:"permission_ids,omitempty"`
	// Role ID. Omit or set to 0 to create.
	RoleID uint64 `json:"role_id,omitempty" toon:"role_id,omitempty"`
	// Role display name. 1–39 characters.
	RoleName string `json:"role_name" toon:"role_name"`
}

RoleUpsertRequest is generated from the Flashduty OpenAPI schema.

type RoleUpsertResponse 

type RoleUpsertResponse struct {
	// Created or updated role ID.
	RoleID uint64 `json:"role_id" toon:"role_id"`
	// Role name echoed from the request.
	RoleName string `json:"role_name" toon:"role_name"`
}

RoleUpsertResponse is generated from the Flashduty OpenAPI schema.

type RolesPermissionsService 

type RolesPermissionsService service

RolesPermissionsService handles the "Platform/Roles & permissions" API resource.

func (*RolesPermissionsService) ReadInfo 

func (s *RolesPermissionsService) ReadInfo(ctx context.Context, req *RoleInfoRequest) (*RoleItem, *Response, error)

Get role detail.

Return the detail of a single role by its ID.

API: POST /role/info (role-read-info).

func (*RolesPermissionsService) ReadList 

func (s *RolesPermissionsService) ReadList(ctx context.Context, req *RoleListRequest) (*RoleListResponse, *Response, error)

List roles.

Return all custom and built-in roles for the current account.

API: POST /role/list (role-read-list).

func (*RolesPermissionsService) ReadListPermission 

func (s *RolesPermissionsService) ReadListPermission(ctx context.Context, req *RolePermissionListRequest) (*RolePermissionListResponse, *Response, error)

List permissions.

Return all available permissions, optionally filtered to those granted to specific roles.

API: POST /role/permission/list (role-read-list-permission).

func (*RolesPermissionsService) ReadListPermissionFactor 

func (s *RolesPermissionsService) ReadListPermissionFactor(ctx context.Context, req *PermissionFactorListRequest) (*PermissionFactorListResponse, *Response, error)

List permission factors.

Return all permission factors (API, button, menu, URL, visit) granted to the calling member, optionally filtered by type. Requires a member-scoped credential — calls authenticated as the account principal (e.g. an account-level app key) are rejected with a 400, because the account principal implicitly holds every permission.

API: POST /role/permission/factor/list (role-read-list-permission-factor).

func (*RolesPermissionsService) WriteDelete 

func (s *RolesPermissionsService) WriteDelete(ctx context.Context, req *RoleDeleteRequest) (*Response, error)

Delete a role.

Delete a custom role. While members still hold the role, the call fails with `ReferenceExist` unless `is_force` is true.

API: POST /role/delete (role-write-delete).

func (*RolesPermissionsService) WriteDisable 

func (s *RolesPermissionsService) WriteDisable(ctx context.Context, req *RoleIDRequest) (*Response, error)

Disable a role.

Disable a custom role to prevent it from granting permissions.

API: POST /role/disable (role-write-disable).

func (*RolesPermissionsService) WriteEnable 

func (s *RolesPermissionsService) WriteEnable(ctx context.Context, req *RoleIDRequest) (*Response, error)

Enable a role.

Re-enable a previously disabled custom role.

API: POST /role/enable (role-write-enable).

func (*RolesPermissionsService) WriteGrantRole 

func (s *RolesPermissionsService) WriteGrantRole(ctx context.Context, req *RoleGrantRequest) (*Response, error)

Grant role to members.

Assign a role to one or more members, giving them its permissions.

API: POST /role/member/grant (role-write-grant-role).

func (*RolesPermissionsService) WriteRevokeRole 

func (s *RolesPermissionsService) WriteRevokeRole(ctx context.Context, req *RoleGrantRequest) (*Response, error)

Revoke role from members.

Remove a role from one or more members, revoking the permissions it granted.

API: POST /role/member/revoke (role-write-revoke-role).

func (*RolesPermissionsService) WriteUpsert 

func (s *RolesPermissionsService) WriteUpsert(ctx context.Context, req *RoleUpsertRequest) (*RoleUpsertResponse, *Response, error)

Create or update a role.

Create a new custom role or update an existing one. Pass `role_id` to update.

API: POST /role/upsert (role-write-upsert).

type RouteCase 

type RouteCase struct {
	// Target channel IDs. Required when `routing_mode` is `standard` (or empty); returned as `null` for `name_mapping`.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// If `true`, evaluation continues to the next case after this one matches; otherwise matching stops at the first hit.
	Fallthrough bool `json:"fallthrough,omitempty" toon:"fallthrough,omitempty"`
	// List of match conditions that are AND-ed together.
	If []RouteMatchCondition `json:"if" toon:"if"`
	// Label key whose value is used as the target channel name. Required when `routing_mode` is `name_mapping`.
	NameMappingLabel string `json:"name_mapping_label,omitempty" toon:"name_mapping_label,omitempty"`
	// Routing mode. `standard` (default, also used when left empty) routes to the fixed channel IDs; `name_mapping` resolves channels by reading a label value from the alert event.
	RoutingMode string `json:"routing_mode,omitempty" toon:"routing_mode,omitempty"`
}

RouteCase is generated from the Flashduty OpenAPI schema.

type RouteDefault 

type RouteDefault struct {
	// Channel IDs to fall back to.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
}

RouteDefault is generated from the Flashduty OpenAPI schema.

type RouteInfoRequest 

type RouteInfoRequest struct {
	// Integration ID. Must be greater than 0.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
}

RouteInfoRequest is generated from the Flashduty OpenAPI schema.

type RouteItem 

type RouteItem struct {
	// Ordered list of case branches.
	Cases []RouteCase `json:"cases" toon:"cases"`
	// Creation time, Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// ID of the person who created the rule.
	CreatorID int64        `json:"creator_id" toon:"creator_id"`
	Default   RouteDefault `json:"default" toon:"default"`
	// Soft-delete timestamp, Unix seconds. Omitted when the rule is active.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Integration the rule belongs to.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Optional sections that visually group cases.
	Sections []RouteSection `json:"sections" toon:"sections"`
	// Route status. `enabled` means active; `deleted` means removed, visible only in historical versions.
	Status string `json:"status" toon:"status"`
	// Last update time, Unix timestamp in seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// ID of the person who performed the last update.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
	// Monotonic version number, incremented on each update. Use it for optimistic concurrency control.
	Version int64 `json:"version" toon:"version"`
}

RouteItem is generated from the Flashduty OpenAPI schema.

type RouteMatchCondition 

type RouteMatchCondition struct {
	// Field key to match against the alert event (e.g. `alert_severity`, `labels.service`).
	Key string `json:"key" toon:"key"`
	// Match operator. `IN` matches when the field value is one of `vals`; `NOTIN` matches when it is not.
	Oper string `json:"oper" toon:"oper"`
	// Values to compare against. Each value may be a literal string, a wildcard (`*`, `?`), a regular expression wrapped in slashes (`/pattern/`), a CIDR (`cidr:10.0.0.0/8`), or a numeric comparison (`num:lt:100`).
	Vals []string `json:"vals" toon:"vals"`
}

RouteMatchCondition is generated from the Flashduty OpenAPI schema.

type RouteSection 

type RouteSection struct {
	// Section name. Must be unique within the rule.
	Name string `json:"name" toon:"name"`
	// Index in `cases` where this section starts. Must be between 0 and the length of `cases`.
	Position int64 `json:"position" toon:"position"`
}

RouteSection is generated from the Flashduty OpenAPI schema.

type RuleAuditListResponse 

type RuleAuditListResponse []AlertRuleAudit

RuleAuditListResponse is a list response payload.

type RuleBasicListResponse 

type RuleBasicListResponse []AlertRuleBasic

RuleBasicListResponse is a list response payload.

type RuleConfigs 

type RuleConfigs struct {
	// Any-data check configuration. Fires when the query returns any data rows.
	CheckAnydata RuleConfigsCheckAnydata `json:"check_anydata,omitzero" toon:"check_anydata,omitempty"`
	// No-data check configuration.
	CheckNodata RuleConfigsCheckNodata `json:"check_nodata,omitzero" toon:"check_nodata,omitempty"`
	// Threshold check configuration.
	CheckThreshold RuleConfigsCheckThreshold `json:"check_threshold,omitzero" toon:"check_threshold,omitempty"`
	// Query list with at least one entry; each needs a unique `name` (`R` and `__all__` are reserved) and a non-empty, non-duplicate `expr`.
	Queries []RuleConfigsQueriesItem `json:"queries" toon:"queries"`
	// Optional auxiliary queries whose results are attached to alert events as context. Each entry must have a unique `name` (not duplicating any query name) and a non-empty `expr`.
	RelateQueries []RuleConfigsRelateQueriesItem `json:"relate_queries,omitempty" toon:"relate_queries,omitempty"`
}

RuleConfigs is generated from the Flashduty OpenAPI schema.

type RuleConfigsCheckAnydata 

type RuleConfigsCheckAnydata struct {
	// Number of consecutive evaluations that must satisfy the condition before alerting; minimum 1.
	AlertingCheckTimes int64 `json:"alerting_check_times,omitempty" toon:"alerting_check_times,omitempty"`
	// Whether any-data checking is enabled: any returned data row triggers an alert.
	Enabled bool `json:"enabled,omitempty" toon:"enabled,omitempty"`
	// Whether to push a recovery event notification when the alert resolves.
	PushRecoveryEvent bool `json:"push_recovery_event,omitempty" toon:"push_recovery_event,omitempty"`
	// Recovery condition for any-data check. If omitted or `mode` is empty, treated as `nodata`.
	Recovery RuleConfigsCheckAnydataRecovery `json:"recovery,omitzero" toon:"recovery,omitempty"`
	// Number of consecutive evaluations that must satisfy the recovery condition before resolving; minimum 1.
	RecoveryCheckTimes int64 `json:"recovery_check_times,omitempty" toon:"recovery_check_times,omitempty"`
	// Severity of any-data alert events; case-sensitive.
	Severity string `json:"severity,omitempty" toon:"severity,omitempty"`
}

RuleConfigsCheckAnydata is generated from the Flashduty OpenAPI schema.

type RuleConfigsCheckAnydataRecovery 

type RuleConfigsCheckAnydataRecovery struct {
	// Datasource-specific options for the recovery query, same convention as `queries[].args`; required for Elasticsearch datasources when `mode` is `ql`.
	Args map[string]string `json:"args,omitempty" toon:"args,omitempty"`
	// Recovery expression. Required when `mode` is `ql`.
	Condition string `json:"condition,omitempty" toon:"condition,omitempty"`
	// `nodata` = recover when the query returns no data; `ql` = recover when the `condition` expression evaluates to true. When `mode` is `ql`, only a single query (`name=A`) is permitted.
	Mode string `json:"mode,omitempty" toon:"mode,omitempty"`
}

RuleConfigsCheckAnydataRecovery is generated from the Flashduty OpenAPI schema.

type RuleConfigsCheckNodata 

type RuleConfigsCheckNodata struct {
	// Whether to trigger an alert when every query returns an empty result.
	AlertOnEmptyResult bool `json:"alert_on_empty_result,omitempty" toon:"alert_on_empty_result,omitempty"`
	// Severity of empty-result alerts, case-sensitive; only effective when `alert_on_empty_result` is enabled.
	AlertOnEmptyResultSeverity string `json:"alert_on_empty_result_severity,omitempty" toon:"alert_on_empty_result_severity,omitempty"`
	// Number of consecutive evaluations that must satisfy the condition before alerting; minimum 1.
	AlertingCheckTimes int64 `json:"alerting_check_times,omitempty" toon:"alerting_check_times,omitempty"`
	// Whether no-data checking is enabled: a previously-seen series that stops returning data triggers an alert.
	Enabled bool `json:"enabled,omitempty" toon:"enabled,omitempty"`
	// Whether to push a recovery event notification when the alert resolves.
	PushRecoveryEvent bool `json:"push_recovery_event,omitempty" toon:"push_recovery_event,omitempty"`
	// Number of consecutive evaluations that must satisfy the recovery condition before resolving; minimum 1.
	RecoveryCheckTimes int64 `json:"recovery_check_times,omitempty" toon:"recovery_check_times,omitempty"`
	// Auto-resolve after N seconds.
	ResolveTimeout int64 `json:"resolve_timeout,omitempty" toon:"resolve_timeout,omitempty"`
	// Severity of no-data alert events; case-sensitive.
	Severity string `json:"severity,omitempty" toon:"severity,omitempty"`
}

RuleConfigsCheckNodata is generated from the Flashduty OpenAPI schema.

type RuleConfigsCheckThreshold 

type RuleConfigsCheckThreshold struct {
	// Number of consecutive evaluations that must satisfy the condition before alerting; minimum 1.
	AlertingCheckTimes int64 `json:"alerting_check_times,omitempty" toon:"alerting_check_times,omitempty"`
	// Critical threshold expression referencing query results via `$<query>` or `$<query>.<value_field>`, e.g. `$A > 90`; at least one severity must be configured.
	Critical string `json:"critical,omitempty" toon:"critical,omitempty"`
	// Whether threshold checking is enabled.
	Enabled bool `json:"enabled,omitempty" toon:"enabled,omitempty"`
	// Info threshold expression, same syntax as `critical`.
	Info string `json:"info,omitempty" toon:"info,omitempty"`
	// Whether to push a recovery event notification when the alert resolves.
	PushRecoveryEvent bool `json:"push_recovery_event,omitempty" toon:"push_recovery_event,omitempty"`
	// Recovery evaluation configuration for threshold checks.
	Recovery RuleConfigsCheckThresholdRecovery `json:"recovery,omitzero" toon:"recovery,omitempty"`
	// Number of consecutive evaluations that must satisfy the recovery condition before resolving; minimum 1.
	RecoveryCheckTimes int64 `json:"recovery_check_times,omitempty" toon:"recovery_check_times,omitempty"`
	// Warning threshold expression, same syntax as `critical`.
	Warning string `json:"warning,omitempty" toon:"warning,omitempty"`
}

RuleConfigsCheckThreshold is generated from the Flashduty OpenAPI schema.

type RuleConfigsCheckThresholdRecovery 

type RuleConfigsCheckThresholdRecovery struct {
	// Datasource-specific extra parameters for the recovery query, using the same `<datasource>.<param>` key convention as query `args`. Omitted when empty.
	Args map[string]string `json:"args,omitempty" toon:"args,omitempty"`
	// Recovery condition expression; required when `mode` is `threshold` or `ql`, and must be empty for `invert`.
	Condition string `json:"condition,omitempty" toon:"condition,omitempty"`
	// Recovery mode: `invert` = resolve when the alert expression no longer holds (`condition` stays empty); `threshold` = resolve when the `condition` threshold expression holds; `ql` = resolve when the `condition` query expression evaluates true.
	Mode string `json:"mode,omitempty" toon:"mode,omitempty"`
	// Numeric result fields the recovery `condition` references as `$A.<field>`; same semantics as the query's `value_fields`. Omitted when empty.
	ValueFields []string `json:"value_fields,omitempty" toon:"value_fields,omitempty"`
}

RuleConfigsCheckThresholdRecovery is generated from the Flashduty OpenAPI schema.

type RuleConfigsQueriesItem 

type RuleConfigsQueriesItem struct {
	// Datasource-specific query options keyed by the `<datasource>.<option>` convention (e.g. `es.type`, `tencent_cls.limit`); most datasources need none.
	Args map[string]string `json:"args,omitempty" toon:"args,omitempty"`
	// Query expression.
	Expr string `json:"expr,omitempty" toon:"expr,omitempty"`
	// Result fields that become alert event labels — identical label sets collapse into one alert; must not overlap `value_fields`; applies to table-shaped results (SQL/ES-style datasources).
	LabelFields []string `json:"label_fields,omitempty" toon:"label_fields,omitempty"`
	// Query identifier (letter, e.g. `A`). The name `R` is reserved and must not be used.
	Name string `json:"name,omitempty" toon:"name,omitempty"`
	// Numeric result fields used in threshold evaluation (referenced as `$A.<field>` in threshold expressions); required for threshold checks unless the datasource is `prometheus`/`loki`/`victorialogs`; field names must not contain `.`.
	ValueFields []string `json:"value_fields,omitempty" toon:"value_fields,omitempty"`
}

RuleConfigsQueriesItem is generated from the Flashduty OpenAPI schema.

type RuleConfigsRelateQueriesItem 

type RuleConfigsRelateQueriesItem struct {
	// Datasource-specific options for the auxiliary query, same convention as `queries[].args`.
	Args map[string]string `json:"args,omitempty" toon:"args,omitempty"`
	// Query expression.
	Expr string `json:"expr,omitempty" toon:"expr,omitempty"`
	// Relate-query identifier.
	Name string `json:"name,omitempty" toon:"name,omitempty"`
}

RuleConfigsRelateQueriesItem is generated from the Flashduty OpenAPI schema.

type RuleCounterChannelResponse 

type RuleCounterChannelResponse map[string]int64

RuleCounterChannelResponse is a map response payload.

type RuleCounterNodeResponse 

type RuleCounterNodeResponse map[string]int64

RuleCounterNodeResponse is a map response payload.

type RuleCounterTotalResponse 

type RuleCounterTotalResponse []AlertRuleCounter

RuleCounterTotalResponse is a list response payload.

type RuleCreateResponse 

type RuleCreateResponse struct {
	// Newly created rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name echoed back from the request.
	RuleName string `json:"rule_name" toon:"rule_name"`
}

RuleCreateResponse is generated from the Flashduty OpenAPI schema.

type RuleDsTypesResponse 

type RuleDsTypesResponse []DsType

RuleDsTypesResponse is a list response payload.

type RuleEmptyRequest 

type RuleEmptyRequest struct{}

RuleEmptyRequest is generated from the Flashduty OpenAPI schema.

type RuleEmptyResponse 

type RuleEmptyResponse struct{}

RuleEmptyResponse is generated from the Flashduty OpenAPI schema.

type RuleFieldsUpdateRequest 

type RuleFieldsUpdateRequest struct {
	// Annotation key-value pairs delivered with alert events; keys must not start with `$` (reserved for query fields). Effective only when `fields` includes `annotations`.
	Annotations map[string]string `json:"annotations,omitempty" toon:"annotations,omitempty"`
	// Partial annotation update. Effective only when `fields` includes `annotations`; takes precedence over `annotations` when both are sent.
	AnnotationsPatch StringMapPatch `json:"annotations_patch,omitzero" toon:"annotations_patch,omitempty"`
	// IDs of the collaboration spaces alerts are sent to; may be empty. Effective only when `fields` includes `channel_ids`.
	ChannelIDs []uint64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Schedule expression: a 6-field cron (with seconds) or an `@every 30s` interval descriptor; `CRON_TZ=`/`TZ=` prefixes are not allowed. Effective only when `fields` includes `cron_pattern`.
	CronPattern string `json:"cron_pattern,omitempty" toon:"cron_pattern,omitempty"`
	// Whether to enable debug logging; the edge emits detailed evaluation logs for troubleshooting. Effective only when `fields` includes `debug_log_enabled`.
	DebugLogEnabled bool `json:"debug_log_enabled,omitempty" toon:"debug_log_enabled,omitempty"`
	// Seconds to shift the evaluation query window backward, compensating for data ingestion latency. Effective only when `fields` includes `delay_seconds`.
	DelaySeconds int64 `json:"delay_seconds,omitempty" toon:"delay_seconds,omitempty"`
	// Rule description (Markdown). Effective only when `fields` includes `description`.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Datasource IDs, merged with `ds_list` to decide which datasources the rule monitors; IDs survive datasource renames. Effective only when `fields` includes `ds_ids`.
	DsIDs []uint64 `json:"ds_ids,omitempty" toon:"ds_ids,omitempty"`
	// Datasource name match patterns; wildcards supported. Effective only when `fields` includes `ds_list`.
	DsList []string `json:"ds_list,omitempty" toon:"ds_list,omitempty"`
	// Datasource type identifier; allowed values are listed by `POST /monit/rule/dstypes`. Effective only when `fields` includes `ds_type`.
	DsType string `json:"ds_type,omitempty" toon:"ds_type,omitempty"`
	// Whether the rule is enabled. Setting it to `false` makes the server clean up the rule's active alerts. Effective only when `fields` includes `enabled`.
	Enabled bool `json:"enabled,omitempty" toon:"enabled,omitempty"`
	// Time windows during which the rule is in effect; element structure see `EnabledTime`. Effective only when `fields` includes `enabled_times`.
	EnabledTimes []EnabledTime `json:"enabled_times,omitempty" toon:"enabled_times,omitempty"`
	// Field names to update. Only listed fields are updated, taking new values from the same-named request fields; values for unlisted fields are silently ignored.
	Fields []string `json:"fields" toon:"fields"`
	// Rule IDs to update.
	IDs []uint64 `json:"ids" toon:"ids"`
	// Custom label key-value pairs; replaces existing labels as a whole. Effective only when `fields` includes `labels`.
	Labels map[string]string `json:"labels,omitempty" toon:"labels,omitempty"`
	// Partial label update. Effective only when `fields` includes `labels`; takes precedence over `labels` when both are sent.
	LabelsPatch StringMapPatch `json:"labels_patch,omitzero" toon:"labels_patch,omitempty"`
	// Interval in seconds between repeated alert notifications. Effective only when `fields` includes `repeat_interval`.
	RepeatInterval int64 `json:"repeat_interval,omitempty" toon:"repeat_interval,omitempty"`
	// Maximum number of repeated notifications. Effective only when `fields` includes `repeat_total`.
	RepeatTotal int64 `json:"repeat_total,omitempty" toon:"repeat_total,omitempty"`
	// Timezone in which the rule executes. IANA timezone name; defaults to `Asia/Shanghai`.
	Timezone string `json:"timezone,omitempty" toon:"timezone,omitempty"`
}

RuleFieldsUpdateRequest is generated from the Flashduty OpenAPI schema.

type RuleIDRequest 

type RuleIDRequest struct {
	// Alert rule ID. Obtainable per folder via `POST /monit/rule/list/basic`.
	ID uint64 `json:"id" toon:"id"`
}

RuleIDRequest is generated from the Flashduty OpenAPI schema.

type RuleIDsRequest 

type RuleIDsRequest struct {
	// Rule IDs.
	IDs []uint64 `json:"ids" toon:"ids"`
}

RuleIDsRequest is generated from the Flashduty OpenAPI schema.

type RuleImportRequest 

type RuleImportRequest []AlertRule

RuleImportRequest is a list response payload.

type RuleImportResponse 

type RuleImportResponse []NameMessage

RuleImportResponse is a list response payload.

type RuleListRequest 

type RuleListRequest struct {
	// Folder ID. Must be an existing folder; `0` is rejected with a `folder_not_found` error.
	FolderID uint64 `json:"folder_id,omitempty" toon:"folder_id,omitempty"`
	// Also include rules from all descendant folders. When `true`, each returned item carries only `id`, `folder_id` and `name`; combine with `query` / `limit` for rule-picker scenarios.
	IncludeDescendants bool `json:"include_descendants,omitempty" toon:"include_descendants,omitempty"`
	// Max number of rules returned; only effective when `include_descendants` is `true`. Defaults to 50, capped at 100.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
	// Rule name fuzzy filter; only effective when `include_descendants` is `true`.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
}

RuleListRequest is generated from the Flashduty OpenAPI schema.

type RuleMoveRequest 

type RuleMoveRequest struct {
	// Destination folder ID. Obtainable via `POST /monit/folder/list`.
	DestFolderID uint64 `json:"dest_folder_id" toon:"dest_folder_id"`
	// Rule IDs to move.
	IDs []uint64 `json:"ids" toon:"ids"`
}

RuleMoveRequest is generated from the Flashduty OpenAPI schema.

type RuleNameMessageListResponse 

type RuleNameMessageListResponse []NameMessage

RuleNameMessageListResponse is a list response payload.

type RuleSetsService 

type RuleSetsService service

RuleSetsService handles the "Monitors/Rule sets" API resource.

func (*RuleSetsService) Create 

func (s *RuleSetsService) Create(ctx context.Context, req *StoreRulesetUpsertRequest) (*StoreRulesetItem, *Response, error)

Create ruleset.

Create a new ruleset in the rule repository.

API: POST /monit/store/ruleset/create (monit-store-ruleset-create).

func (*RuleSetsService) Delete 

func (s *RuleSetsService) Delete(ctx context.Context, req *IDRequest) (*Response, error)

Delete ruleset.

Delete a ruleset from the rule repository by ID.

API: POST /monit/store/ruleset/delete (monit-store-ruleset-delete).

func (*RuleSetsService) Info 

func (s *RuleSetsService) Info(ctx context.Context, req *IDRequest) (*StoreRulesetItem, *Response, error)

Get ruleset detail.

Retrieve the full details of a ruleset including its `payload` (the alert rule definitions as a JSON string).

API: POST /monit/store/ruleset/info (monit-store-ruleset-info).

func (*RuleSetsService) List 

func (s *RuleSetsService) List(ctx context.Context, req *StoreRulesetListRequest) (*StoreRulesetListResponse, *Response, error)

List rulesets.

Return all rulesets for a given datasource type that are accessible to the current user.

API: POST /monit/store/ruleset/list (monit-store-ruleset-list).

func (*RuleSetsService) Update 

func (s *RuleSetsService) Update(ctx context.Context, req *StoreRulesetUpdateRequest) (*StoreRulesetItem, *Response, error)

Update ruleset.

Update the note, sharing flag, and payload of an existing ruleset.

API: POST /monit/store/ruleset/update (monit-store-ruleset-update).

type RuleStatusResponse 

type RuleStatusResponse []AlertRuleStatus

RuleStatusResponse is a list response payload.

type SLSLogstoresRequest 

type SLSLogstoresRequest struct {
	// ID of an SLS-type datasource. Obtainable via `POST /monit/datasource/list`.
	ID uint64 `json:"id" toon:"id"`
	// Pagination offset.
	Offset int64 `json:"offset,omitempty" toon:"offset,omitempty"`
	// SLS project name. Obtainable via `POST /monit/datasource/sls/projects`.
	Project string `json:"project,omitempty" toon:"project,omitempty"`
	// Page size. Defaults to 200 server-side when 0.
	Size int64 `json:"size,omitempty" toon:"size,omitempty"`
}

SLSLogstoresRequest is generated from the Flashduty OpenAPI schema.

type SLSLogstoresResponse 

type SLSLogstoresResponse []string

SLSLogstoresResponse is a list response payload.

type SLSProject added in v0.14.3 

type SLSProject struct {
	// Creation time, Unix seconds rendered as a string, e.g. `"1524539357"`.
	CreateTime string `json:"createTime" toon:"createTime"`
	// Data redundancy type: `LRS` = locally redundant storage, `ZRS` = zone-redundant storage. Omitted when not set.
	DataRedundancyType string `json:"dataRedundancyType" toon:"dataRedundancyType"`
	// Project description.
	Description string `json:"description" toon:"description"`
	// Last modification time, Unix seconds rendered as a string.
	LastModifyTime string `json:"lastModifyTime" toon:"lastModifyTime"`
	// Storage location, e.g. `cn-beijing-b`. Omitted when not set.
	Location string `json:"location" toon:"location"`
	// Owner Aliyun account ID; empty when not returned by SLS.
	Owner string `json:"owner" toon:"owner"`
	// Project name.
	ProjectName string `json:"projectName" toon:"projectName"`
	// Region ID, e.g. `cn-shanghai`.
	Region string `json:"region" toon:"region"`
	// Project status, e.g. `Normal`.
	Status string `json:"status" toon:"status"`
}

SLSProject is generated from the Flashduty OpenAPI schema.

type SLSProjectsRequest 

type SLSProjectsRequest struct {
	// ID of an SLS-type datasource. Obtainable via `POST /monit/datasource/list`.
	ID uint64 `json:"id" toon:"id"`
	// Pagination offset.
	Offset int64 `json:"offset,omitempty" toon:"offset,omitempty"`
	// Fuzzy filter on project description (maps to the `description` parameter of Aliyun SLS ListProject). Leave empty to return all.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Page size. Defaults to 200 server-side when 0.
	Size int64 `json:"size,omitempty" toon:"size,omitempty"`
}

SLSProjectsRequest is generated from the Flashduty OpenAPI schema.

type SLSProjectsResponse 

type SLSProjectsResponse struct {
	// Number of projects in this page.
	Count int64 `json:"count" toon:"count"`
	// Projects in the current page.
	Projects []SLSProject `json:"projects" toon:"projects"`
	// Total number of projects matching `query`, independent of pagination.
	Total int64 `json:"total" toon:"total"`
}

SLSProjectsResponse is generated from the Flashduty OpenAPI schema.

type ScheduleCalculatedLayer 

type ScheduleCalculatedLayer struct {
	// Layer display name.
	LayerName string `json:"layer_name" toon:"layer_name"`
	// Layer mode: 0 = common rotation, 1 = override.
	Mode int64 `json:"mode" toon:"mode"`
	// Layer internal name.
	Name string `json:"name" toon:"name"`
	// Computed shifts; null when the layer produces none.
	Schedules []ScheduleCalculatedSchedule `json:"schedules" toon:"schedules"`
}

ScheduleCalculatedLayer is generated from the Flashduty OpenAPI schema.

type ScheduleCalculatedSchedule 

type ScheduleCalculatedSchedule struct {
	// Shift end timestamp (Unix seconds).
	End Timestamp `json:"end" toon:"end"`
	// Oncall group covering the shift; null marks a coverage gap.
	Group ScheduleGroup `json:"group" toon:"group"`
	// Index inside the rotation.
	Index int64 `json:"index" toon:"index"`
	// Shift start timestamp (Unix seconds).
	Start Timestamp `json:"start" toon:"start"`
}

ScheduleCalculatedSchedule is generated from the Flashduty OpenAPI schema.

type ScheduleDayMask 

type ScheduleDayMask struct {
	// Weekday numbers (0 = Sunday) included in the rotation. Conflicts with restrict_mode = 2 (week).
	Repeat []int64 `json:"repeat,omitempty" toon:"repeat,omitempty"`
}

ScheduleDayMask is generated from the Flashduty OpenAPI schema.

type ScheduleEmptyObject 

type ScheduleEmptyObject struct{}

ScheduleEmptyObject is generated from the Flashduty OpenAPI schema.

type ScheduleFixedTimeNotifyInfo 

type ScheduleFixedTimeNotifyInfo struct {
	// Notification cycle; only `day` is supported.
	Cycle string `json:"cycle" toon:"cycle"`
	// Time of day to send, format `HH:MM` (24-hour).
	Start string `json:"start" toon:"start"`
}

ScheduleFixedTimeNotifyInfo is generated from the Flashduty OpenAPI schema.

type ScheduleGroup 

type ScheduleGroup struct {
	// Group end timestamp (Unix seconds).
	End int64 `json:"end" toon:"end"`
	// Group display name. Null when only the legacy name is set.
	GroupName *string `json:"group_name,omitempty" toon:"group_name,omitempty"`
	// Members of this group.
	Members []ScheduleMember `json:"members" toon:"members"`
	// Legacy group name.
	Name string `json:"name" toon:"name"`
	// Group start timestamp (Unix seconds).
	Start int64 `json:"start" toon:"start"`
}

ScheduleGroup is generated from the Flashduty OpenAPI schema.

type ScheduleIDResponse 

type ScheduleIDResponse struct {
	// ID of the newly created schedule.
	ScheduleID int64 `json:"schedule_id" toon:"schedule_id"`
}

ScheduleIDResponse is generated from the Flashduty OpenAPI schema.

type ScheduleIDsBodyRequest 

type ScheduleIDsBodyRequest struct {
	// Schedule IDs to operate on; obtain them from `POST /schedule/list`.
	ScheduleIDs []int64 `json:"schedule_ids" toon:"schedule_ids"`
}

ScheduleIDsBodyRequest is generated from the Flashduty OpenAPI schema.

type ScheduleIDsRequest 

type ScheduleIDsRequest struct {
	// Schedule ID list; obtain IDs from `POST /schedule/list`.
	ScheduleIDs []int64 `json:"schedule_ids" toon:"schedule_ids"`
}

ScheduleIDsRequest is generated from the Flashduty OpenAPI schema.

type ScheduleImNotify 

type ScheduleImNotify struct {
	// Webhook channel settings.
	Settings ScheduleImNotifySettings `json:"settings" toon:"settings"`
	// IM provider type (for example feishu_app, dingtalk_app, wecom_app, teams_app, slack_app).
	Type string `json:"type" toon:"type"`
}

ScheduleImNotify is generated from the Flashduty OpenAPI schema.

type ScheduleImNotifySettings 

type ScheduleImNotifySettings struct {
	// Channel alias.
	Alias string `json:"alias" toon:"alias"`
	// Chat IDs.
	ChatIDs []string `json:"chat_ids" toon:"chat_ids"`
	// Data source ID.
	DataSourceID int64 `json:"data_source_id" toon:"data_source_id"`
	// Signature secret.
	SignSecret string `json:"sign_secret" toon:"sign_secret"`
	// Webhook token.
	Token string `json:"token" toon:"token"`
	// Verification token.
	VerifyToken string `json:"verify_token" toon:"verify_token"`
}

ScheduleImNotifySettings is generated from the Flashduty OpenAPI schema.

type ScheduleInfoRequest 

type ScheduleInfoRequest struct {
	// Preview end timestamp (Unix seconds, 10 digits).
	End int64 `json:"end" toon:"end"`
	// Schedule ID; obtain it from `POST /schedule/list`.
	ScheduleID int64 `json:"schedule_id" toon:"schedule_id"`
	// Preview start timestamp (Unix seconds, 10 digits).
	Start int64 `json:"start" toon:"start"`
}

ScheduleInfoRequest is generated from the Flashduty OpenAPI schema.

type ScheduleItem 

type ScheduleItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Creation timestamp (Unix seconds).
	CreateAt Timestamp `json:"create_at" toon:"create_at"`
	// Creator person ID.
	CreateBy int64 `json:"create_by" toon:"create_by"`
	// Current on-call group, or null when nobody is on-call.
	CurOncall ScheduleOncallGroup `json:"cur_oncall" toon:"cur_oncall"`
	// Schedule description. null when returned from /schedule/preview.
	Description string `json:"description" toon:"description"`
	// Disabled flag (0 = enabled, 1 = disabled). Deprecated. null when returned from /schedule/preview.
	Disabled int64 `json:"disabled" toon:"disabled"`
	// Window end (Unix seconds). Omitted when 0 (no window requested).
	End Timestamp `json:"end" toon:"end"`
	// Field name used by the legacy update-field endpoint.
	Field string `json:"field" toon:"field"`
	// Collapsed final schedule across all layers.
	FinalSchedule ScheduleCalculatedLayer `json:"final_schedule" toon:"final_schedule"`
	// Legacy team/group ID. null when returned from /schedule/preview.
	GroupID int64 `json:"group_id" toon:"group_id"`
	// Schedule ID. null when returned from /schedule/preview.
	ID int64 `json:"id" toon:"id"`
	// Alias of schedule_layers returned for compatibility. Null when not computed.
	LayerSchedules []ScheduleCalculatedLayer `json:"layer_schedules" toon:"layer_schedules"`
	// Rotation layers defined on the schedule. Null when layers were not loaded (for example by `/schedule/infos`, or by `/schedule/list` without start/end).
	Layers []ScheduleLayer `json:"layers" toon:"layers"`
	// Schedule name (legacy field; mirrors schedule_name). null when returned from /schedule/preview.
	Name string `json:"name" toon:"name"`
	// Next on-call group, or null when unknown.
	NextOncall ScheduleOncallGroup `json:"next_oncall" toon:"next_oncall"`
	// Notification configuration. Null when the schedule has none.
	Notify ScheduleNotify `json:"notify" toon:"notify"`
	// Schedule ID. Null when returned from `/schedule/preview`.
	ScheduleID int64 `json:"schedule_id" toon:"schedule_id"`
	// Computed per-layer schedules for the requested window. Null when not computed.
	ScheduleLayers []ScheduleCalculatedLayer `json:"schedule_layers" toon:"schedule_layers"`
	// Schedule display name. null when returned from /schedule/preview.
	ScheduleName string `json:"schedule_name" toon:"schedule_name"`
	// Window start (Unix seconds). Omitted when 0 (no window requested).
	Start Timestamp `json:"start" toon:"start"`
	// Legacy status flag. Deprecated. null when returned from /schedule/preview.
	Status int64 `json:"status" toon:"status"`
	// Owning team ID. null when returned from /schedule/preview.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Last update timestamp (Unix seconds).
	UpdateAt Timestamp `json:"update_at" toon:"update_at"`
	// Last updater person ID.
	UpdateBy int64 `json:"update_by" toon:"update_by"`
}

ScheduleItem is generated from the Flashduty OpenAPI schema.

type ScheduleLayer 

type ScheduleLayer struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Creation timestamp (Unix seconds).
	CreateAt int64 `json:"create_at" toon:"create_at"`
	// Creator person ID.
	CreateBy int64 `json:"create_by" toon:"create_by"`
	// Day-of-week mask.
	DayMask ScheduleDayMask `json:"day_mask" toon:"day_mask"`
	// When the layer becomes effective (Unix seconds).
	EnableTime int64 `json:"enable_time" toon:"enable_time"`
	// When the layer expires (Unix seconds, 0 means never).
	ExpireTime int64 `json:"expire_time" toon:"expire_time"`
	// Whether fair rotation is enabled.
	FairRotation bool `json:"fair_rotation" toon:"fair_rotation"`
	// Oncall groups participating in the rotation. Null when not set.
	Groups []ScheduleGroup `json:"groups" toon:"groups"`
	// Rotation handoff time as a weekly offset in seconds (weekday x 86400 + seconds since midnight), not an absolute Unix timestamp.
	HandoffTime int64 `json:"handoff_time" toon:"handoff_time"`
	// Whether the layer is hidden in the UI (0 = no, 1 = yes).
	Hidden int64 `json:"hidden" toon:"hidden"`
	// Layer end timestamp (Unix seconds). null means open-ended.
	LayerEnd *int64 `json:"layer_end,omitempty" toon:"layer_end,omitempty"`
	// User-facing layer name. Null when not set.
	LayerName *string `json:"layer_name,omitempty" toon:"layer_name,omitempty"`
	// Layer effective start (Unix seconds). Null when not set.
	LayerStart *int64 `json:"layer_start,omitempty" toon:"layer_start,omitempty"`
	// Whether continuous masking is enabled.
	MaskContinuousEnabled bool `json:"mask_continuous_enabled" toon:"mask_continuous_enabled"`
	// Layer mode: 0 = common rotation, 1 = override.
	Mode int64 `json:"mode" toon:"mode"`
	// Layer internal name.
	Name string `json:"name" toon:"name"`
	// Legacy end offset inside the restriction window (seconds).
	RestrictEnd int64 `json:"restrict_end" toon:"restrict_end"`
	// Restriction mode: 0 = none, 1 = day, 2 = week.
	RestrictMode int64 `json:"restrict_mode" toon:"restrict_mode"`
	// Restriction windows inside each rotation cycle. Null when not set.
	RestrictPeriods []ScheduleRestrictPeriod `json:"restrict_periods" toon:"restrict_periods"`
	// Legacy start offset inside the restriction window (seconds).
	RestrictStart int64 `json:"restrict_start" toon:"restrict_start"`
	// Rotation duration in seconds.
	RotationDuration int64 `json:"rotation_duration" toon:"rotation_duration"`
	// Rotation unit. On-call assignees rotate in turn by this unit.
	// | Value | Meaning |
	// |---|---|
	// | `hour` | Rotates hourly. |
	// | `day` | Rotates daily. |
	// | `week` | Rotates weekly. |
	// | `month` | Rotates monthly. |
	RotationUnit string `json:"rotation_unit" toon:"rotation_unit"`
	// Rotation quantity (number of rotation_unit per cycle).
	RotationValue int64 `json:"rotation_value" toon:"rotation_value"`
	// Parent schedule ID.
	ScheduleID int64 `json:"schedule_id" toon:"schedule_id"`
	// Last update timestamp (Unix seconds).
	UpdateAt int64 `json:"update_at" toon:"update_at"`
	// Last updater person ID.
	UpdateBy int64 `json:"update_by" toon:"update_by"`
	// Layer weight for ordering.
	Weight int64 `json:"weight" toon:"weight"`
}

ScheduleLayer is generated from the Flashduty OpenAPI schema.

type ScheduleListRequest 

type ScheduleListRequest struct {
	ListOptions
	// Window end timestamp (Unix seconds).
	End int64 `json:"end,omitempty" toon:"end,omitempty"`
	// Only return schedules created by the current user within their teams.
	IsMyManage bool `json:"is_my_manage,omitempty" toon:"is_my_manage,omitempty"`
	// Only return schedules whose owning team the current user belongs to.
	IsMyTeam bool `json:"is_my_team,omitempty" toon:"is_my_team,omitempty"`
	// Search keyword matched against schedule name or description.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// When set together with end, computed layer schedules are returned. Span must be less than 45 days.
	Start int64 `json:"start,omitempty" toon:"start,omitempty"`
	// Filter by team IDs.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

ScheduleListRequest is generated from the Flashduty OpenAPI schema.

type ScheduleListResponse 

type ScheduleListResponse struct {
	// Schedules on this page; null when no schedule matches.
	Items []ScheduleItem `json:"items" toon:"items"`
	// Total number of schedules matching the filters.
	Total int64 `json:"total" toon:"total"`
}

ScheduleListResponse is generated from the Flashduty OpenAPI schema.

type ScheduleMember 

type ScheduleMember struct {
	// Person IDs in this slot.
	PersonIDs []int64 `json:"person_ids" toon:"person_ids"`
	// Oncall role ID.
	RoleID int64 `json:"role_id" toon:"role_id"`
}

ScheduleMember is generated from the Flashduty OpenAPI schema.

type ScheduleNotify 

type ScheduleNotify struct {
	// Advance notification lead time in seconds. `0` notifies exactly at shift start; omitting disables advance notification.
	AdvanceInTime *int64 `json:"advance_in_time,omitempty" toon:"advance_in_time,omitempty"`
	// Recipient notification preference; null when not configured.
	By ScheduleNotifyBy `json:"by" toon:"by"`
	// Fixed-time notification config; null when not configured.
	FixedTime ScheduleFixedTimeNotifyInfo `json:"fixed_time" toon:"fixed_time"`
	// Legacy IM-type to token map.
	Im map[string]string `json:"im,omitempty" toon:"im,omitempty"`
	// IM webhook notification channels; null when not configured.
	Webhooks []ScheduleImNotify `json:"webhooks" toon:"webhooks"`
}

ScheduleNotify is generated from the Flashduty OpenAPI schema.

type ScheduleNotifyBy 

type ScheduleNotifyBy struct {
	// Whether to follow each responder's personal notification preference.
	FollowPreference bool `json:"follow_preference" toon:"follow_preference"`
	// Personal notification channel keys.
	PersonalChannels []string `json:"personal_channels" toon:"personal_channels"`
}

ScheduleNotifyBy is generated from the Flashduty OpenAPI schema.

type ScheduleOncallGroup 

type ScheduleOncallGroup struct {
	// Shift end timestamp (Unix seconds).
	End Timestamp `json:"end" toon:"end"`
	// Oncall group on duty for the shift.
	Group ScheduleGroup `json:"group" toon:"group"`
	// Index inside the rotation.
	Index int64 `json:"index" toon:"index"`
	// Shift start timestamp (Unix seconds).
	Start Timestamp `json:"start" toon:"start"`
	// Update timestamp (Unix seconds).
	UpdateAt Timestamp `json:"update_at" toon:"update_at"`
	// Layer weight the shift comes from.
	Weight int64 `json:"weight" toon:"weight"`
}

ScheduleOncallGroup is generated from the Flashduty OpenAPI schema.

type ScheduleRestrictPeriod 

type ScheduleRestrictPeriod struct {
	// End offset inside the rotation cycle.
	RestrictEnd int64 `json:"restrict_end" toon:"restrict_end"`
	// Start offset inside the rotation cycle.
	RestrictStart int64 `json:"restrict_start" toon:"restrict_start"`
}

ScheduleRestrictPeriod is generated from the Flashduty OpenAPI schema.

type ScheduleSelfRequest 

type ScheduleSelfRequest struct {
	// Window end (Unix seconds, 10 digits). Required. Must be within 45 days of start.
	End int64 `json:"end" toon:"end"`
	// Window start (Unix seconds, 10 digits). Required.
	Start int64 `json:"start" toon:"start"`
}

ScheduleSelfRequest is generated from the Flashduty OpenAPI schema.

type ScheduleSelfResponse 

type ScheduleSelfResponse struct {
	// Schedules assigned to the current user (or matching the requested IDs); null when none.
	Items []ScheduleItem `json:"items" toon:"items"`
}

ScheduleSelfResponse is generated from the Flashduty OpenAPI schema.

type ScheduleUpsertRequest 

type ScheduleUpsertRequest struct {
	// Schedule description. Max 500 characters.
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// 0 = enabled, 1 = disabled. Defaults to enabled when omitted.
	Disabled *int64 `json:"disabled,omitempty" toon:"disabled,omitempty"`
	// Preview window end (Unix seconds, 10 digits). Required for /schedule/preview. Max 45 days after start.
	End int64 `json:"end,omitempty" toon:"end,omitempty"`
	// Rotation layers.
	Layers []ScheduleLayer `json:"layers,omitempty" toon:"layers,omitempty"`
	// Legacy schedule name field. Used when schedule_name is empty.
	Name *string `json:"name,omitempty" toon:"name,omitempty"`
	// Rotation notification configuration.
	Notify ScheduleNotify `json:"notify,omitzero" toon:"notify,omitempty"`
	// Schedule ID, required on update; obtain it from `POST /schedule/list`.
	ScheduleID *int64 `json:"schedule_id,omitempty" toon:"schedule_id,omitempty"`
	// Schedule display name. Max 40 characters.
	ScheduleName *string `json:"schedule_name,omitempty" toon:"schedule_name,omitempty"`
	// Preview window start (Unix seconds, 10 digits). Required for /schedule/preview.
	Start int64 `json:"start,omitempty" toon:"start,omitempty"`
	// Owning team ID; obtain it from `POST /team/list`.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
}

ScheduleUpsertRequest is generated from the Flashduty OpenAPI schema.

type SchedulesService 

type SchedulesService service

SchedulesService handles the "On-call/Schedules" API resource.

func (*SchedulesService) Create 

func (s *SchedulesService) Create(ctx context.Context, req *ScheduleUpsertRequest) (*ScheduleIDResponse, *Response, error)

Create schedule.

Create a new on-call schedule (escalation rule schedule).

API: POST /schedule/create (scheduleCreate).

func (*SchedulesService) Delete 

func (s *SchedulesService) Delete(ctx context.Context, req *ScheduleIDsBodyRequest) (*Response, error)

Delete schedules.

Delete one or more on-call schedules by ID.

API: POST /schedule/delete (scheduleDelete).

func (*SchedulesService) Info 

func (s *SchedulesService) Info(ctx context.Context, req *ScheduleInfoRequest) (*ScheduleItem, *Response, error)

Get schedule info.

Return details of an on-call schedule including the computed schedule layers for the requested time window (max 45 days).

API: POST /schedule/info (scheduleInfo).

func (*SchedulesService) Infos 

func (s *SchedulesService) Infos(ctx context.Context, req *ScheduleIDsRequest) (*ScheduleSelfResponse, *Response, error)

Batch get schedules.

Return details of multiple on-call schedules by their IDs.

API: POST /schedule/infos (scheduleInfos).

func (*SchedulesService) List 

func (s *SchedulesService) List(ctx context.Context, req *ScheduleListRequest) (*ScheduleListResponse, *Response, error)

List schedules.

Return a paginated list of on-call schedules. When both start and end are provided (max 45 days apart), computed layer schedules are included.

API: POST /schedule/list (scheduleList).

func (*SchedulesService) Preview 

func (s *SchedulesService) Preview(ctx context.Context, req *ScheduleUpsertRequest) (*ScheduleItem, *Response, error)

Preview schedule.

Preview the coverage generated by a schedule configuration without persisting it. The request accepts the same body as create/update plus a required start/end window (max 45 days).

API: POST /schedule/preview (schedulePreview).

func (*SchedulesService) Self 

func (s *SchedulesService) Self(ctx context.Context, req *ScheduleSelfRequest) (*ScheduleSelfResponse, *Response, error)

List my schedules.

Return on-call schedules where the current user is assigned.

API: POST /schedule/self (scheduleSelf).

func (*SchedulesService) Update 

func (s *SchedulesService) Update(ctx context.Context, req *ScheduleUpsertRequest) (*Response, error)

Update schedule.

Update an existing on-call schedule. Provide schedule_id to identify the schedule.

API: POST /schedule/update (scheduleUpdate).

type ServiceDeskPlusRequestListRequest added in v0.5.8 

type ServiceDeskPlusRequestListRequest struct {
	ListOptions
	// When `true`, sort by internal record ID ascending; otherwise descending.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Channel IDs to filter by.
	ChannelIDs []int64 `json:"channel_ids,omitempty" toon:"channel_ids,omitempty"`
	// Window end, Unix seconds. Must be greater than or equal to `start_time`. Optional when `incident_id` is provided.
	EndTime int64 `json:"end_time,omitempty" toon:"end_time,omitempty"`
	// Flashduty incident ID. When set, the time window can be omitted.
	IncidentID string `json:"incident_id,omitempty" toon:"incident_id,omitempty"`
	// ServiceDeskPlus integration ID.
	IntegrationID int64 `json:"integration_id,omitempty" toon:"integration_id,omitempty"`
	// ServiceDeskPlus request ID.
	RequestID string `json:"request_id,omitempty" toon:"request_id,omitempty"`
	// Window start, Unix seconds. Optional when `incident_id` is provided.
	StartTime int64 `json:"start_time,omitempty" toon:"start_time,omitempty"`
	// Filter by sync status: `success` or `failed`.
	Status string `json:"status,omitempty" toon:"status,omitempty"`
}

ServiceDeskPlusRequestListRequest is generated from the Flashduty OpenAPI schema.

type ServiceDeskPlusRequestListResponse added in v0.5.8 

type ServiceDeskPlusRequestListResponse struct {
	// True when more results are available.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Synchronization records on the current page.
	Items []ServiceDeskPlusRequestMappingItem `json:"items" toon:"items"`
	// Cursor for the next page. Empty when no more data is available.
	SearchAfterCtx string `json:"search_after_ctx" toon:"search_after_ctx"`
	// Total number of matching records, capped at 1,000 for counting.
	Total int64 `json:"total" toon:"total"`
}

ServiceDeskPlusRequestListResponse is generated from the Flashduty OpenAPI schema.

type ServiceDeskPlusRequestMappingItem added in v0.5.8 

type ServiceDeskPlusRequestMappingItem struct {
	// Channel ID for the incident.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Channel name for the incident.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Mapping record creation time, Unix seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Error message when synchronization failed. Usually absent on successful records.
	ErrorMessage string `json:"error_message" toon:"error_message"`
	// Associated Flashduty incident ID.
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// Associated incident title.
	IncidentTitle string `json:"incident_title" toon:"incident_title"`
	// ServiceDeskPlus integration ID.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// ServiceDeskPlus request ID.
	RequestID string `json:"request_id" toon:"request_id"`
	// ServiceDeskPlus request detail URL.
	RequestLink string `json:"request_link" toon:"request_link"`
	// Synchronization status.
	Status string `json:"status" toon:"status"`
}

ServiceDeskPlusRequestMappingItem is generated from the Flashduty OpenAPI schema.

type ServiceMapAnchor added in v0.10.0 

type ServiceMapAnchor struct {
	// Optional process/entity ID within the host to anchor on. Omit to anchor on the whole host.
	EntityID string `json:"entity_id,omitempty" toon:"entity_id,omitempty"`
	// Stable ServiceMap host identifier, e.g. `host_0123...`. Must already be known to ServiceMap.
	HostID string `json:"host_id" toon:"host_id"`
}

ServiceMapAnchor is generated from the Flashduty OpenAPI schema.

type ServiceMapCapability added in v0.10.0 

type ServiceMapCapability struct {
	// Capture mode, e.g. `ebpf` or `polling`.
	CaptureMode string `json:"capture_mode" toon:"capture_mode"`
	// True if ServiceMap collection is enabled on this host.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Host ID this capability describes.
	HostID string `json:"host_id" toon:"host_id"`
	// True if the host has an inventory row with ServiceMap capability metadata at all.
	Present bool `json:"present" toon:"present"`
	// Machine-readable codes explaining the current capability status.
	ReasonCodes []string `json:"reason_codes" toon:"reason_codes"`
	// Configured reporting interval in milliseconds.
	ReportIntervalMs int64 `json:"report_interval_ms" toon:"report_interval_ms"`
	// True if the agent has produced at least one full snapshot.
	SnapshotReady bool `json:"snapshot_ready" toon:"snapshot_ready"`
	// Agent-reported capability status, e.g. `running`, `disabled`, `starting`, `failed`, `unsupported`.
	Status string `json:"status" toon:"status"`
}

ServiceMapCapability is generated from the Flashduty OpenAPI schema.

type ServiceMapEdge added in v0.10.0 

type ServiceMapEdge struct {
	// Traversal depth this edge was discovered at, relative to the anchor.
	Depth int64 `json:"depth" toon:"depth"`
	// Destination endpoint of the connection.
	Destination ServiceMapEndpoint `json:"destination" toon:"destination"`
	// Resolution of the destination endpoint to candidate target nodes.
	EndpointResolution ServiceMapEndpointResolution `json:"endpoint_resolution" toon:"endpoint_resolution"`
	// How the edge was observed, e.g. `connect`.
	Evidence string `json:"evidence" toon:"evidence"`
	// Timestamp the edge was first observed.
	FirstSeen string `json:"first_seen" toon:"first_seen"`
	// Host the edge's source node lives on.
	HostID string `json:"host_id" toon:"host_id"`
	// Edge ID, unique within its host.
	ID string `json:"id" toon:"id"`
	// Timestamp the edge was last observed.
	LastSeen string `json:"last_seen" toon:"last_seen"`
	// Opaque per-edge metrics payload, only present when `include_metrics=true` was requested.
	Metrics any `json:"metrics" toon:"metrics"`
	// Entity ID of the source node.
	SourceEntityID string `json:"source_entity_id" toon:"source_entity_id"`
	// Network namespace ID the connection originated from.
	SourceNetnsID string `json:"source_netns_id" toon:"source_netns_id"`
}

ServiceMapEdge is generated from the Flashduty OpenAPI schema.

type ServiceMapEndpoint added in v0.10.0 

type ServiceMapEndpoint struct {
	// Destination IP address.
	IP string `json:"ip" toon:"ip"`
	// Destination port.
	Port int64 `json:"port" toon:"port"`
	// Transport protocol, `tcp` or `udp`.
	Protocol string `json:"protocol" toon:"protocol"`
}

ServiceMapEndpoint is generated from the Flashduty OpenAPI schema.

type ServiceMapEndpointResolution added in v0.10.0 

type ServiceMapEndpointResolution struct {
	// Candidate nodes found for this endpoint, ranked by confidence.
	Candidates []ServiceMapResolutionCandidate `json:"candidates" toon:"candidates"`
	// True if the candidate list was cut short by an internal query budget.
	CandidatesTruncated bool `json:"candidates_truncated" toon:"candidates_truncated"`
	// The destination endpoint being resolved.
	Endpoint ServiceMapEndpoint `json:"endpoint" toon:"endpoint"`
	// Machine-readable reason code when `status` is not `resolved`, e.g. `no_current_listener`, `multiple_current_listeners`, `query_budget_exceeded`.
	Reason string `json:"reason" toon:"reason"`
	// Resolution outcome. `resolved` = exactly one confident candidate; `ambiguous` = multiple or low-confidence candidates; `unresolved` = no candidate found.
	Status string `json:"status" toon:"status"`
}

ServiceMapEndpointResolution is generated from the Flashduty OpenAPI schema.

type ServiceMapFleetBrowseRequest added in v0.10.0 

type ServiceMapFleetBrowseRequest struct {
	// Filter to hosts on any of these exact agent versions. Up to 20 values.
	AgentVersions []string `json:"agent_versions,omitempty" toon:"agent_versions,omitempty"`
	// Filter to hosts using any of these capture modes. `unknown` matches hosts that have not reported a capture mode yet.
	CaptureModes []string `json:"capture_modes,omitempty" toon:"capture_modes,omitempty"`
	// Opaque pagination cursor. Pass back the exact value from a previous response's `next_cursor`; omit for the first page.
	Cursor string `json:"cursor,omitempty" toon:"cursor,omitempty"`
	// Filter to hosts in any of these exact edge cluster names. Up to 20 values.
	EdgeClusters []string `json:"edge_clusters,omitempty" toon:"edge_clusters,omitempty"`
	// Maximum number of matching hosts to return in this page. Default 50, range 1-100.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
	// Maximum number of candidate hosts to examine while filling this page. Default 1000, range `limit`-2000.
	ScanLimit int64 `json:"scan_limit,omitempty" toon:"scan_limit,omitempty"`
	// Filter to hosts currently in any of these statuses. Up to 20 values.
	Statuses []string `json:"statuses,omitempty" toon:"statuses,omitempty"`
}

ServiceMapFleetBrowseRequest is generated from the Flashduty OpenAPI schema.

type ServiceMapFleetBrowseResponse added in v0.10.0 

type ServiceMapFleetBrowseResponse struct {
	// Coverage of the candidate scan that produced this page.
	Coverage ServiceMapFleetCoverage `json:"coverage" toon:"coverage"`
	// Unix timestamp in milliseconds this response was generated.
	GeneratedAtMs TimestampMilli `json:"generated_at_ms" toon:"generated_at_ms"`
	// Matching hosts for this page.
	Items []ServiceMapFleetHost `json:"items" toon:"items"`
	// Opaque cursor to fetch the next page. Absent when there are no more candidates to scan.
	NextCursor string `json:"next_cursor" toon:"next_cursor"`
	// True if any host in this page failed to read status, or the scan was truncated.
	Partial bool `json:"partial" toon:"partial"`
	// True if `scan_limit` was reached before finding `limit` matches; `next_cursor` may still find more.
	Truncated bool `json:"truncated" toon:"truncated"`
	// Machine-readable reasons the scan was truncated, when `truncated=true`.
	TruncationReasons []string `json:"truncation_reasons" toon:"truncation_reasons"`
}

ServiceMapFleetBrowseResponse is generated from the Flashduty OpenAPI schema.

type ServiceMapFleetCoverage added in v0.10.0 

type ServiceMapFleetCoverage struct {
	// Number of candidate hosts whose status could not be read.
	Failed int64 `json:"failed" toon:"failed"`
	// Number of scanned hosts that passed all filters.
	Matched int64 `json:"matched" toon:"matched"`
	// Number of matched hosts included in this page (`<= limit`).
	Returned int64 `json:"returned" toon:"returned"`
	// Number of distinct candidate hosts actually examined in this request.
	Scanned int64 `json:"scanned" toon:"scanned"`
	// Count of returned items per status value; always includes all seven status keys, zero-filled. Reflects only this page, not the account's full population.
	States map[string]int64 `json:"states" toon:"states"`
}

ServiceMapFleetCoverage is generated from the Flashduty OpenAPI schema.

type ServiceMapFleetHost added in v0.10.0 

type ServiceMapFleetHost struct {
	// Agent version reported by this host.
	AgentVersion string `json:"agent_version" toon:"agent_version"`
	// Edge cluster name this host belongs to.
	EdgeCluster string `json:"edge_cluster" toon:"edge_cluster"`
	// Stable ServiceMap host identifier.
	HostID string `json:"host_id" toon:"host_id"`
	// ServiceMap capability and current collection status for this host.
	Servicemap ServiceMapFleetHostCapability `json:"servicemap" toon:"servicemap"`
}

ServiceMapFleetHost is generated from the Flashduty OpenAPI schema.

type ServiceMapFleetHostCapability added in v0.10.0 

type ServiceMapFleetHostCapability struct {
	// True if the host has an authoritative current graph.
	Authoritative bool `json:"authoritative" toon:"authoritative"`
	// Agent-reported capability status, e.g. `running`, `disabled`, `starting`, `failed`, `unsupported`.
	CapabilityStatus string `json:"capability_status" toon:"capability_status"`
	// Capture mode, e.g. `ebpf` or `polling`.
	CaptureMode string `json:"capture_mode" toon:"capture_mode"`
	// Number of edges in the host's current graph.
	EdgeCount int64 `json:"edge_count" toon:"edge_count"`
	// True if ServiceMap collection is enabled on this host.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Set to `status_unavailable` when this host's live status could not be read; other fields fall back to inventory-derived defaults in that case.
	ErrorCode string `json:"error_code" toon:"error_code"`
	// Freshness classification of the host's graph. `fresh` = the latest snapshot was received within 2× the report interval; `stale` = no new snapshot within 2× the report interval; `unknown` = no topology snapshot ever received, freshness undecidable.
	FreshnessStatus string `json:"freshness_status" toon:"freshness_status"`
	// True if a current graph can be fetched for this host right now.
	GraphAvailable bool `json:"graph_available" toon:"graph_available"`
	// Age in milliseconds of the host's graph data, relative to when this response was generated.
	MaxAgeMs int64 `json:"max_age_ms" toon:"max_age_ms"`
	// Number of nodes in the host's current graph.
	NodeCount int64 `json:"node_count" toon:"node_count"`
	// Unix timestamp in milliseconds the host's graph was observed by the agent.
	ObservedAtMs TimestampMilli `json:"observed_at_ms" toon:"observed_at_ms"`
	// Machine-readable codes explaining the current status.
	ReasonCodes []string `json:"reason_codes" toon:"reason_codes"`
	// Unix timestamp in milliseconds the host's current graph generation was received by the server.
	ReceivedAtMs TimestampMilli `json:"received_at_ms" toon:"received_at_ms"`
	// Configured reporting interval in milliseconds.
	ReportIntervalMs int64 `json:"report_interval_ms" toon:"report_interval_ms"`
	// True if the agent has produced at least one full snapshot.
	SnapshotReady bool `json:"snapshot_ready" toon:"snapshot_ready"`
	// Overall ServiceMap collection status.
	//
	// | Value | Meaning |
	// |---|---|
	// | `active` | Collection healthy: a fresh snapshot exists with no degradation. |
	// | `degraded` | Collecting but quality is impaired: health reports are newer than the snapshot, the snapshot is truncated/degraded, or collection is failing. |
	// | `stale` | A snapshot exists but is outdated (not updated within 2× the report interval). |
	// | `initializing` | The agent has reported the capability but the first snapshot is not ready yet. |
	// | `disabled` | Topology collection is disabled on this host. |
	// | `unsupported` | The agent or kernel does not support this collection. |
	// | `no_data` | No snapshot or health data received at all. |
	Status string `json:"status" toon:"status"`
}

ServiceMapFleetHostCapability is generated from the Flashduty OpenAPI schema.

type ServiceMapFleetSummaryCoverage added in v0.10.0 

type ServiceMapFleetSummaryCoverage struct {
	// Number of matched hosts successfully classified into one of the seven statuses; equals the sum of `states`.
	Classified int64 `json:"classified" toon:"classified"`
	// Number of hosts whose candidate/detail read raced or whose live status could not be read.
	Failed int64 `json:"failed" toon:"failed"`
	// Number of scanned hosts that passed the agent version / edge cluster / capture mode filters and still have a current inventory row.
	Matched int64 `json:"matched" toon:"matched"`
	// Number of distinct candidate hosts actually examined.
	Scanned int64 `json:"scanned" toon:"scanned"`
	// Count of hosts per status value; always includes all seven keys, zero-filled.
	States map[string]int64 `json:"states" toon:"states"`
}

ServiceMapFleetSummaryCoverage is generated from the Flashduty OpenAPI schema.

type ServiceMapFleetSummaryRequest added in v0.10.0 

type ServiceMapFleetSummaryRequest struct {
	// Filter to hosts on any of these exact agent versions. Up to 20 values.
	AgentVersions []string `json:"agent_versions,omitempty" toon:"agent_versions,omitempty"`
	// Filter to hosts using any of these capture modes. `unknown` matches hosts that have not reported a capture mode yet.
	CaptureModes []string `json:"capture_modes,omitempty" toon:"capture_modes,omitempty"`
	// Filter to hosts in any of these exact edge cluster names. Up to 20 values.
	EdgeClusters []string `json:"edge_clusters,omitempty" toon:"edge_clusters,omitempty"`
	// Maximum number of candidate hosts to scan. Default 2000, range 1-5000.
	ScanLimit int64 `json:"scan_limit,omitempty" toon:"scan_limit,omitempty"`
}

ServiceMapFleetSummaryRequest is generated from the Flashduty OpenAPI schema.

type ServiceMapFleetSummaryResponse added in v0.10.0 

type ServiceMapFleetSummaryResponse struct {
	// Aggregate status distribution across the scanned candidate hosts.
	Coverage ServiceMapFleetSummaryCoverage `json:"coverage" toon:"coverage"`
	// Unix timestamp in milliseconds this response was generated.
	GeneratedAtMs TimestampMilli `json:"generated_at_ms" toon:"generated_at_ms"`
	// True if the scan was truncated or any host failed to classify.
	Partial bool `json:"partial" toon:"partial"`
	// The normalized scan budget actually applied, echoing the default when the request omitted it.
	ScanLimit int64 `json:"scan_limit" toon:"scan_limit"`
	// True if `scan_limit` was reached before scanning every candidate host in the account.
	Truncated bool `json:"truncated" toon:"truncated"`
	// Machine-readable reasons the scan was truncated, when `truncated=true`.
	TruncationReasons []string `json:"truncation_reasons" toon:"truncation_reasons"`
}

ServiceMapFleetSummaryResponse is generated from the Flashduty OpenAPI schema.

type ServiceMapFreshness added in v0.10.0 

type ServiceMapFreshness struct {
	// Age in milliseconds of the staleest graph covered, relative to now.
	MaxAgeMs int64 `json:"max_age_ms" toon:"max_age_ms"`
	// Unix timestamp in milliseconds of the most recently received graph among the hosts covered.
	NewestReceivedAtMs TimestampMilli `json:"newest_received_at_ms" toon:"newest_received_at_ms"`
	// Unix timestamp in milliseconds of the least recently received graph among the hosts covered.
	OldestReceivedAtMs TimestampMilli `json:"oldest_received_at_ms" toon:"oldest_received_at_ms"`
	// Freshness classification. `fresh` = the latest snapshot was received within 2× the report interval; `stale` = no new snapshot within 2× the report interval; `unknown` = no snapshot data, undecidable.
	Status string `json:"status" toon:"status"`
}

ServiceMapFreshness is generated from the Flashduty OpenAPI schema.

type ServiceMapHostCoverage added in v0.10.0 

type ServiceMapHostCoverage struct {
	// True if the host's graph was degraded at collection time.
	Degraded bool `json:"degraded" toon:"degraded"`
	// Kubernetes enrichment status for this host, as self-reported by the agent.
	KubernetesEnrichmentStatus string `json:"kubernetes_enrichment_status" toon:"kubernetes_enrichment_status"`
	// Network-inventory enrichment status for this host, e.g. `complete`, `partial`, `unavailable`, as self-reported by the agent.
	NetworkInventoryStatus string `json:"network_inventory_status" toon:"network_inventory_status"`
	// Machine-readable codes explaining the current coverage status.
	ReasonCodes []string `json:"reason_codes" toon:"reason_codes"`
	// True if the host's graph was truncated at collection time.
	Truncated bool `json:"truncated" toon:"truncated"`
}

ServiceMapHostCoverage is generated from the Flashduty OpenAPI schema.

type ServiceMapNode added in v0.10.0 

type ServiceMapNode struct {
	// Container name, when the node runs in a container.
	ContainerName string `json:"container_name" toon:"container_name"`
	// Human-readable display name.
	DisplayName string `json:"display_name" toon:"display_name"`
	// Executable file name.
	ExecutableName string `json:"executable_name" toon:"executable_name"`
	// Timestamp the node was first observed.
	FirstSeen string `json:"first_seen" toon:"first_seen"`
	// Host the node was observed on.
	HostID string `json:"host_id" toon:"host_id"`
	// Entity ID of the node, unique within its host.
	ID string `json:"id" toon:"id"`
	// Opaque, kind-specific identity payload. Shape depends on `kind`.
	Identity any `json:"identity" toon:"identity"`
	// Container image repository.
	ImageRepository string `json:"image_repository" toon:"image_repository"`
	// Container image tag/version.
	ImageVersion string `json:"image_version" toon:"image_version"`
	// Number of instances folded into this node, when the node represents a workload replica set.
	InstanceCount int64 `json:"instance_count" toon:"instance_count"`
	// Node kind, e.g. `process`, `container`.
	Kind string `json:"kind" toon:"kind"`
	// Timestamp the node was last observed.
	LastSeen string `json:"last_seen" toon:"last_seen"`
	// Kubernetes namespace, when known.
	Namespace string `json:"namespace" toon:"namespace"`
	// Opaque sample of underlying instances folded into this node, when applicable.
	SampleInstances any `json:"sample_instances" toon:"sample_instances"`
	// systemd unit name, when the node is a systemd-managed process.
	SystemdUnit string `json:"systemd_unit" toon:"systemd_unit"`
	// Kubernetes workload name, when known.
	WorkloadName string `json:"workload_name" toon:"workload_name"`
}

ServiceMapNode is generated from the Flashduty OpenAPI schema.

type ServiceMapResolutionCandidate added in v0.10.0 

type ServiceMapResolutionCandidate struct {
	// Match confidence in `[0, 1]`; capped at 0.6 whenever more than one candidate is returned.
	Confidence float64 `json:"confidence" toon:"confidence"`
	// Destination IP actually being resolved against this candidate.
	EffectiveIP string `json:"effective_ip" toon:"effective_ip"`
	// Entity/process ID of the candidate listener.
	EntityID string `json:"entity_id" toon:"entity_id"`
	// Sequence number of the graph generation this candidate was observed in.
	GraphSequence uint64 `json:"graph_sequence" toon:"graph_sequence"`
	// Host ID of the candidate listener.
	HostID string `json:"host_id" toon:"host_id"`
	// Identifier of the matched listener.
	ListenerID string `json:"listener_id" toon:"listener_id"`
	// IP address the listener is bound to (may be a wildcard address).
	ListenerIP string `json:"listener_ip" toon:"listener_ip"`
	// How the listener matched the destination, e.g. `exact`, `wildcard`, `wildcard_dual_stack`, `wildcard_address_family_unknown`.
	MatchKind string `json:"match_kind" toon:"match_kind"`
	// Network namespace ID the candidate listener is in.
	NetnsID string `json:"netns_id" toon:"netns_id"`
	// Display name of the candidate's owning node, when known.
	NodeDisplayName string `json:"node_display_name" toon:"node_display_name"`
	// Kind of the candidate's owning node, when known.
	NodeKind string `json:"node_kind" toon:"node_kind"`
	// Unix timestamp in milliseconds when the candidate's graph generation was observed by the agent.
	ObservedAtMs TimestampMilli `json:"observed_at_ms" toon:"observed_at_ms"`
	// Destination port.
	Port int64 `json:"port" toon:"port"`
	// Transport protocol, `tcp` or `udp`.
	Protocol string `json:"protocol" toon:"protocol"`
}

ServiceMapResolutionCandidate is generated from the Flashduty OpenAPI schema.

type ServiceMapResolutionCounts added in v0.10.0 

type ServiceMapResolutionCounts struct {
	// Number of edges resolved to multiple or low-confidence candidates.
	Ambiguous int64 `json:"ambiguous" toon:"ambiguous"`
	// Number of edges resolved to exactly one confident candidate.
	Resolved int64 `json:"resolved" toon:"resolved"`
	// Number of edges with no resolvable candidate.
	Unresolved int64 `json:"unresolved" toon:"unresolved"`
}

ServiceMapResolutionCounts is generated from the Flashduty OpenAPI schema.

type ServiceMapService added in v0.10.0 

type ServiceMapService service

ServiceMapService handles the "Monitors/Service map" API resource.

func (*ServiceMapService) Fleet added in v0.10.0 

func (s *ServiceMapService) Fleet(ctx context.Context, req *ServiceMapFleetBrowseRequest) (*ServiceMapFleetBrowseResponse, *Response, error)

Browse service map fleet hosts.

Browse the account's hosts with ServiceMap capability and current collection status.

API: POST /monit/servicemap/fleet (monit-servicemap-read-fleet).

func (*ServiceMapService) FleetSummary added in v0.10.0 

func (s *ServiceMapService) FleetSummary(ctx context.Context, req *ServiceMapFleetSummaryRequest) (*ServiceMapFleetSummaryResponse, *Response, error)

Get service map fleet summary.

Return an aggregate status distribution across the account's ServiceMap-capable hosts.

API: POST /monit/servicemap/fleet/summary (monit-servicemap-read-fleet-summary).

func (*ServiceMapService) Status added in v0.10.0 

func (s *ServiceMapService) Status(ctx context.Context, req *ServiceMapStatusRequest) (*ServiceMapStatusResponse, *Response, error)

Get service map status.

Return ServiceMap collection status for one or more hosts, or a bounded fleet sample.

API: POST /monit/servicemap/status (monit-servicemap-read-status).

func (*ServiceMapService) Summary added in v0.10.0 

func (s *ServiceMapService) Summary(ctx context.Context, req *ServiceMapSummaryRequest) (*ServiceMapSummaryResponse, *Response, error)

Get service map summary.

Return a bounded, AI-ready summary of a host's outbound service dependencies.

API: POST /monit/servicemap/summary (monit-servicemap-read-summary).

func (*ServiceMapService) Topology added in v0.10.0 

func (s *ServiceMapService) Topology(ctx context.Context, req *ServiceMapTopologyRequest) (*ServiceMapTopologyResponse, *Response, error)

Get service map topology.

Return the outbound dependency graph around a host, discovered by live network observation.

API: POST /monit/servicemap/topology (monit-servicemap-read-topology).

type ServiceMapStatusBatchCoverage added in v0.10.0 

type ServiceMapStatusBatchCoverage struct {
	// Number of hosts whose status could not be read.
	Failed int64 `json:"failed" toon:"failed"`
	// Number of hosts requested (explicit `host_id`/`host_ids`, or the fleet sample size actually scanned).
	Requested int64 `json:"requested" toon:"requested"`
	// Count of items per status value; always includes all seven keys (`active`, `degraded`, `stale`, `initializing`, `disabled`, `unsupported`, `no_data`), zero-filled.
	States map[string]int64 `json:"states" toon:"states"`
	// Number of hosts whose status was read successfully.
	Succeeded int64 `json:"succeeded" toon:"succeeded"`
	// True if `fleet` mode found more candidates than `limit` allowed to return.
	Truncated bool `json:"truncated" toon:"truncated"`
}

ServiceMapStatusBatchCoverage is generated from the Flashduty OpenAPI schema.

type ServiceMapStatusItem added in v0.10.0 

type ServiceMapStatusItem struct {
	// True if the host has an authoritative current graph.
	Authoritative bool `json:"authoritative" toon:"authoritative"`
	// The host's self-reported ServiceMap capability.
	Capability ServiceMapCapability `json:"capability" toon:"capability"`
	// Coverage and enrichment status for this host's graph.
	Coverage ServiceMapHostCoverage `json:"coverage" toon:"coverage"`
	// Number of edges in the host's current graph.
	EdgeCount int64 `json:"edge_count" toon:"edge_count"`
	// Set to `status_unavailable` when this host's status could not be read; other fields fall back to inventory-derived defaults in that case.
	ErrorCode string `json:"error_code" toon:"error_code"`
	// How recent the host's graph data is.
	Freshness ServiceMapFreshness `json:"freshness" toon:"freshness"`
	// True if a current graph can be fetched for this host right now.
	GraphAvailable bool `json:"graph_available" toon:"graph_available"`
	// Host ID this status describes.
	HostID string `json:"host_id" toon:"host_id"`
	// Unix timestamp in milliseconds of the most recent non-authoritative health signal, when more recent than the current graph.
	LatestHealthAtMs TimestampMilli `json:"latest_health_at_ms" toon:"latest_health_at_ms"`
	// Network scope resolved for this host, when known.
	NetworkScopeID string `json:"network_scope_id" toon:"network_scope_id"`
	// Number of nodes in the host's current graph.
	NodeCount int64 `json:"node_count" toon:"node_count"`
	// Unix timestamp in milliseconds the host's graph was observed by the agent.
	ObservedAtMs TimestampMilli `json:"observed_at_ms" toon:"observed_at_ms"`
	// Machine-readable codes explaining the current status.
	ReasonCodes []string `json:"reason_codes" toon:"reason_codes"`
	// Unix timestamp in milliseconds the host's current graph generation was received by the server.
	ReceivedAtMs TimestampMilli `json:"received_at_ms" toon:"received_at_ms"`
	// Configured reporting interval in milliseconds.
	ReportIntervalMs int64 `json:"report_interval_ms" toon:"report_interval_ms"`
	// Overall ServiceMap collection status.
	//
	// | Value | Meaning |
	// |---|---|
	// | `active` | Collection healthy: a fresh snapshot exists with no degradation. |
	// | `degraded` | Collecting but quality is impaired: health reports are newer than the snapshot, the snapshot is truncated/degraded, or collection is failing. |
	// | `stale` | A snapshot exists but is outdated (not updated within 2× the report interval). |
	// | `initializing` | The agent has reported the capability but the first snapshot is not ready yet. |
	// | `disabled` | Topology collection is disabled on this host. |
	// | `unsupported` | The agent or kernel does not support this collection. |
	// | `no_data` | No snapshot or health data received at all. |
	Status string `json:"status" toon:"status"`
}

ServiceMapStatusItem is generated from the Flashduty OpenAPI schema.

type ServiceMapStatusRequest added in v0.10.0 

type ServiceMapStatusRequest struct {
	// When `true`, ignore `host_id`/`host_ids` and instead sample up to `limit` fleet candidate hosts for the account. Default `false`.
	Fleet bool `json:"fleet,omitempty" toon:"fleet,omitempty"`
	// A single host ID to check. Combine with `host_ids` to check several; mutually exclusive with `fleet=true`.
	HostID string `json:"host_id,omitempty" toon:"host_id,omitempty"`
	// Multiple host IDs to check in one call, up to 200 combined with `host_id`. Mutually exclusive with `fleet=true`.
	HostIDs []string `json:"host_ids,omitempty" toon:"host_ids,omitempty"`
	// In `fleet` mode, the number of candidate hosts to sample. Ignored otherwise. Default 100, range 1-200.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
}

ServiceMapStatusRequest is generated from the Flashduty OpenAPI schema.

type ServiceMapStatusResponse added in v0.10.0 

type ServiceMapStatusResponse struct {
	// Summary of how many hosts were successfully covered.
	Coverage ServiceMapStatusBatchCoverage `json:"coverage" toon:"coverage"`
	// Echoes whether this response was produced from a fleet sample rather than explicit host IDs.
	Fleet bool `json:"fleet" toon:"fleet"`
	// Unix timestamp in milliseconds this response was generated.
	GeneratedAtMs TimestampMilli `json:"generated_at_ms" toon:"generated_at_ms"`
	// Per-host status, in the same order the hosts were resolved.
	Items []ServiceMapStatusItem `json:"items" toon:"items"`
	// True if any host failed or the fleet sample was truncated.
	Partial bool `json:"partial" toon:"partial"`
}

ServiceMapStatusResponse is generated from the Flashduty OpenAPI schema.

type ServiceMapSummaryNeighbor added in v0.10.0 

type ServiceMapSummaryNeighbor struct {
	// Active connection count for this relation, when the underlying agent reports it.
	ActiveConnections int64 `json:"active_connections" toon:"active_connections"`
	// Destination IP address.
	DestinationIP string `json:"destination_ip" toon:"destination_ip"`
	// Destination port.
	DestinationPort int64 `json:"destination_port" toon:"destination_port"`
	// Transport protocol of the destination. `tcp` = TCP connection; `udp` = UDP session. Collectors currently only report `tcp`; `udp` is reserved.
	DestinationProtocol string `json:"destination_protocol" toon:"destination_protocol"`
	// Edge ID.
	EdgeID string `json:"edge_id" toon:"edge_id"`
	// Timestamp this relation was last observed.
	LastSeen string `json:"last_seen" toon:"last_seen"`
	// Resolution outcome for this relation's destination. `resolved` = uniquely resolved to a listening entity on a host — the relation is reliable; `ambiguous` = multiple candidates exist (or the listener address family is unknown) — treat the relation as a lead to verify; `unresolved` = no candidate found, the destination identity is unknown.
	ResolutionStatus string `json:"resolution_status" toon:"resolution_status"`
	// Display name of the source node, when known.
	SourceDisplayName string `json:"source_display_name" toon:"source_display_name"`
	// Entity ID of the source node.
	SourceEntityID string `json:"source_entity_id" toon:"source_entity_id"`
	// Display name of the resolved target, when known.
	TargetDisplayName string `json:"target_display_name" toon:"target_display_name"`
	// Entity ID of the resolved target, when `resolution_status=resolved` and unambiguous.
	TargetEntityID string `json:"target_entity_id" toon:"target_entity_id"`
	// Host ID of the resolved target, when `resolution_status=resolved` and unambiguous.
	TargetHostID string `json:"target_host_id" toon:"target_host_id"`
}

ServiceMapSummaryNeighbor is generated from the Flashduty OpenAPI schema.

type ServiceMapSummaryRequest added in v0.10.0 

type ServiceMapSummaryRequest struct {
	// Host (and optional entity) to summarize.
	Anchor ServiceMapAnchor `json:"anchor" toon:"anchor"`
	// Optional integrity check: if set, must match the network scope already associated with `anchor.host_id`, or the request is rejected with `InvalidParameter`.
	NetworkScopeID string `json:"network_scope_id,omitempty" toon:"network_scope_id,omitempty"`
}

ServiceMapSummaryRequest is generated from the Flashduty OpenAPI schema.

type ServiceMapSummaryResponse added in v0.10.0 

type ServiceMapSummaryResponse struct {
	// Echo of the requested anchor entity ID, when one was given.
	AnchorEntityID string `json:"anchor_entity_id" toon:"anchor_entity_id"`
	// Echo of the requested anchor host ID.
	AnchorHostID string `json:"anchor_host_id" toon:"anchor_host_id"`
	// Always `true`; the summary is only ever built from an authoritative graph.
	Authoritative bool `json:"authoritative" toon:"authoritative"`
	// Pre-rendered natural-language evidence string summarizing this response, designed for LLM prompts. The structured fields above are the source of truth; this is a convenience rendering of them.
	ContextRefDetail string `json:"context_ref_detail" toon:"context_ref_detail"`
	// Aggregate coverage and enrichment status for the anchor host's graph.
	Coverage ServiceMapTopologyCoverage `json:"coverage" toon:"coverage"`
	// How recent the graph data is.
	Freshness ServiceMapFreshness `json:"freshness" toon:"freshness"`
	// `current` if the summary reflects the live graph; `last_known_good` if the latest ingestion is unhealthy and this reflects the last authoritative graph instead.
	GraphRole string `json:"graph_role" toon:"graph_role"`
	// False when `graph_role=last_known_good`, i.e. the most recent collection attempt was not authoritative.
	LatestCollectionAuthoritative bool `json:"latest_collection_authoritative" toon:"latest_collection_authoritative"`
	// Unix timestamp in milliseconds of the most recent non-authoritative health signal, when more recent than the current graph.
	LatestHealthAtMs TimestampMilli `json:"latest_health_at_ms" toon:"latest_health_at_ms"`
	// Up to 12 outbound relations, most informative first.
	Neighbors []ServiceMapSummaryNeighbor `json:"neighbors" toon:"neighbors"`
	// Network scope the summary was resolved within.
	NetworkScopeID string `json:"network_scope_id" toon:"network_scope_id"`
	// Unix timestamp in milliseconds the underlying data was observed by the agent.
	ObservedAtMs TimestampMilli `json:"observed_at_ms" toon:"observed_at_ms"`
	// Unix timestamp in milliseconds the current graph generation was received by the server.
	ReceivedAtMs TimestampMilli `json:"received_at_ms" toon:"received_at_ms"`
	// Counts of the anchor host's outbound relations by resolution outcome.
	ResolutionCounts ServiceMapResolutionCounts `json:"resolution_counts" toon:"resolution_counts"`
	// ServiceMap collection status of the anchor host.
	//
	// | Value | Meaning |
	// |---|---|
	// | `active` | Collection healthy: a fresh snapshot exists with no degradation. |
	// | `degraded` | Collecting but quality is impaired: health reports are newer than the snapshot, the snapshot is truncated/degraded, or collection is failing. |
	// | `stale` | A snapshot exists but is outdated (not updated within 2× the report interval). |
	// | `initializing` | The agent has reported the capability but the first snapshot is not ready yet. |
	// | `disabled` | Topology collection is disabled on this host. |
	// | `unsupported` | The agent or kernel does not support this collection. |
	// | `no_data` | No snapshot or health data received at all. |
	Status string `json:"status" toon:"status"`
	// True if the fixed-size summary omitted any neighbor or coverage detail to stay within its bounds.
	Truncated bool `json:"truncated" toon:"truncated"`
	// Machine-readable reasons the summary was truncated, when `truncated=true`.
	TruncationReasons []string `json:"truncation_reasons" toon:"truncation_reasons"`
}

ServiceMapSummaryResponse is generated from the Flashduty OpenAPI schema.

type ServiceMapTopologyCoverage added in v0.10.0 

type ServiceMapTopologyCoverage struct {
	// Distinct capture modes (e.g. `ebpf`) seen across loaded hosts.
	CaptureModes []string `json:"capture_modes" toon:"capture_modes"`
	// Number of loaded host graphs that were degraded at collection time.
	DegradedHosts int64 `json:"degraded_hosts" toon:"degraded_hosts"`
	// Always `outbound`; ServiceMap currently only models outbound relations.
	Direction string `json:"direction" toon:"direction"`
	// Number of distinct host graphs loaded to answer the query.
	HostsLoaded int64 `json:"hosts_loaded" toon:"hosts_loaded"`
	// Number of IPv6 wildcard listeners with a known IPV6_V6ONLY setting.
	Ipv6OnlyKnownListenerCount int64 `json:"ipv6_only_known_listener_count" toon:"ipv6_only_known_listener_count"`
	// Number of IPv6 wildcard listeners whose IPV6_V6ONLY setting could not be determined.
	Ipv6OnlyUnknownListenerCount int64 `json:"ipv6_only_unknown_listener_count" toon:"ipv6_only_unknown_listener_count"`
	// Number of IPv6 wildcard (unspecified-address) listeners observed.
	Ipv6WildcardListenerCount int64 `json:"ipv6_wildcard_listener_count" toon:"ipv6_wildcard_listener_count"`
	// Aggregate Kubernetes enrichment coverage across loaded hosts (worst per-host status wins).
	//
	// | Value | Meaning |
	// |---|---|
	// | `complete` | Every host has full pod-binding metadata for its entities. |
	// | `partial` | At least one host has bindings but some pod metadata is missing or bindings were dropped. |
	// | `unavailable` | At least one host has no pod bindings at all. |
	// | `unknown` | No host loaded, or a host reported an unrecognized status. |
	KubernetesEnrichmentStatus string `json:"kubernetes_enrichment_status" toon:"kubernetes_enrichment_status"`
	// Aggregate listener address-family (IPv4/IPv6) resolution coverage across loaded hosts (worst per-host status wins).
	//
	// | Value | Meaning |
	// |---|---|
	// | `complete` | On every host, the IPv6-only attribute of all IPv6 wildcard listeners is known. |
	// | `partial` | At least one host knows the IPv6-only attribute for only some IPv6 wildcard listeners. |
	// | `unavailable` | At least one host knows the IPv6-only attribute of none of its IPv6 wildcard listeners. |
	// | `unknown` | No host loaded, or a host reported an unrecognized status. |
	ListenerAddressFamilyStatus string `json:"listener_address_family_status" toon:"listener_address_family_status"`
	// Aggregate network-inventory enrichment coverage across loaded hosts (worst per-host status wins).
	//
	// | Value | Meaning |
	// |---|---|
	// | `complete` | Every requested network namespace on every host was scanned successfully with no errors. |
	// | `partial` | At least one host failed to scan some namespaces, or scanning raised errors. |
	// | `unavailable` | At least one host failed to scan all of its namespaces. |
	// | `unknown` | No host loaded, or a host reported an unrecognized status. |
	NetworkInventoryStatus string `json:"network_inventory_status" toon:"network_inventory_status"`
	// Machine-readable reason codes explaining any degraded or truncated state among loaded hosts.
	Reasons []string `json:"reasons" toon:"reasons"`
	// Number of loaded host graphs that were truncated at collection time.
	TruncatedHosts int64 `json:"truncated_hosts" toon:"truncated_hosts"`
}

ServiceMapTopologyCoverage is generated from the Flashduty OpenAPI schema.

type ServiceMapTopologyRequest added in v0.10.0 

type ServiceMapTopologyRequest struct {
	// Host (and optional entity) to start the traversal from.
	Anchor ServiceMapAnchor `json:"anchor" toon:"anchor"`
	// Time selector for the query. Only `now` is currently supported; omitting the field behaves the same.
	At string `json:"at,omitempty" toon:"at,omitempty"`
	// Maximum traversal depth from the anchor. Default 1, maximum 3.
	Depth int64 `json:"depth,omitempty" toon:"depth,omitempty"`
	// Traversal direction. Only `outbound` is currently supported; omitting the field behaves the same.
	Direction string `json:"direction,omitempty" toon:"direction,omitempty"`
	// Whether to include the raw per-edge `metrics` payload in the response. Default `false`.
	IncludeMetrics bool `json:"include_metrics,omitempty" toon:"include_metrics,omitempty"`
	// Maximum number of edges to examine before truncating. Default 200, maximum 1000.
	MaxEdges int64 `json:"max_edges,omitempty" toon:"max_edges,omitempty"`
	// Maximum number of nodes to return before truncating. Default 100, maximum 500.
	MaxNodes int64 `json:"max_nodes,omitempty" toon:"max_nodes,omitempty"`
	// Optional integrity check: if set, must match the network scope already associated with `anchor.host_id`, or the request is rejected with `InvalidParameter`.
	NetworkScopeID string `json:"network_scope_id,omitempty" toon:"network_scope_id,omitempty"`
	// How unresolved edges are projected. `full` (default) includes them in `edges` and `unresolved_endpoints`; `summary` omits them from `edges` and returns only a bounded sample in `unresolved_endpoints`.
	UnresolvedMode string `json:"unresolved_mode,omitempty" toon:"unresolved_mode,omitempty"`
}

ServiceMapTopologyRequest is generated from the Flashduty OpenAPI schema.

type ServiceMapTopologyResponse added in v0.10.0 

type ServiceMapTopologyResponse struct {
	// Echo of the requested anchor entity ID, when one was given.
	AnchorEntityID string `json:"anchor_entity_id" toon:"anchor_entity_id"`
	// Echo of the requested anchor host ID.
	AnchorHostID string `json:"anchor_host_id" toon:"anchor_host_id"`
	// Aggregate coverage and enrichment status across loaded hosts.
	Coverage ServiceMapTopologyCoverage `json:"coverage" toon:"coverage"`
	// Edges discovered during the traversal. Excludes unresolved edges when `unresolved_mode=summary`.
	Edges []ServiceMapEdge `json:"edges" toon:"edges"`
	// How recent the graph data is.
	Freshness ServiceMapFreshness `json:"freshness" toon:"freshness"`
	// Network scope the graph was resolved within.
	NetworkScopeID string `json:"network_scope_id" toon:"network_scope_id"`
	// Nodes discovered during the traversal.
	Nodes []ServiceMapNode `json:"nodes" toon:"nodes"`
	// Unix timestamp in milliseconds the underlying data was observed by the agent (the most recent among loaded hosts).
	ObservedAtMs TimestampMilli `json:"observed_at_ms" toon:"observed_at_ms"`
	// Counts of edges by resolution outcome.
	ResolutionCounts ServiceMapResolutionCounts `json:"resolution_counts" toon:"resolution_counts"`
	// True if any bound (`max_nodes`, `max_edges`, or an internal query budget) cut the traversal short.
	Truncated bool `json:"truncated" toon:"truncated"`
	// Machine-readable reasons the traversal was truncated, when `truncated=true`.
	TruncationReasons []string `json:"truncation_reasons" toon:"truncation_reasons"`
	// Sample or full set of edges whose destination could not be resolved, per `unresolved_projection`.
	UnresolvedEndpoints []ServiceMapUnresolvedEndpoint `json:"unresolved_endpoints" toon:"unresolved_endpoints"`
	// How unresolved edges were projected into this response.
	UnresolvedProjection ServiceMapUnresolvedProjection `json:"unresolved_projection" toon:"unresolved_projection"`
}

ServiceMapTopologyResponse is generated from the Flashduty OpenAPI schema.

type ServiceMapUnresolvedEndpoint added in v0.10.0 

type ServiceMapUnresolvedEndpoint struct {
	// Destination endpoint of the connection.
	Destination ServiceMapEndpoint `json:"destination" toon:"destination"`
	// Edge ID, unique within its host.
	EdgeID string `json:"edge_id" toon:"edge_id"`
	// Host the edge's source node lives on.
	HostID string `json:"host_id" toon:"host_id"`
	// Machine-readable reason the endpoint could not be resolved.
	Reason string `json:"reason" toon:"reason"`
	// Entity ID of the source node.
	SourceEntityID string `json:"source_entity_id" toon:"source_entity_id"`
	// Network namespace ID the connection originated from.
	SourceNetnsID string `json:"source_netns_id" toon:"source_netns_id"`
}

ServiceMapUnresolvedEndpoint is generated from the Flashduty OpenAPI schema.

type ServiceMapUnresolvedProjection added in v0.10.0 

type ServiceMapUnresolvedProjection struct {
	// Breakdown of `total` unresolved edges by reason code.
	ByReason []ServiceMapUnresolvedReasonCount `json:"by_reason" toon:"by_reason"`
	// The `unresolved_mode` that was applied. `full` = unresolved destinations are listed completely in `unresolved_endpoints` and their edges stay in `edges` (default); `summary` = unresolved edges are excluded from `edges` and `unresolved_endpoints` keeps at most 20 samples, complemented by the `by_reason` counts.
	Mode string `json:"mode" toon:"mode"`
	// Number of unresolved edges found but not returned (`total - returned`).
	Omitted int64 `json:"omitted" toon:"omitted"`
	// Number of unresolved edges included in `unresolved_endpoints`.
	Returned int64 `json:"returned" toon:"returned"`
	// Total number of unresolved edges found, regardless of how many were returned.
	Total int64 `json:"total" toon:"total"`
}

ServiceMapUnresolvedProjection is generated from the Flashduty OpenAPI schema.

type ServiceMapUnresolvedReasonCount added in v0.10.0 

type ServiceMapUnresolvedReasonCount struct {
	// Number of unresolved edges with this reason.
	Count int64 `json:"count" toon:"count"`
	// Machine-readable unresolved reason code.
	Reason string `json:"reason" toon:"reason"`
}

ServiceMapUnresolvedReasonCount is generated from the Flashduty OpenAPI schema.

type SessionDeleteRequest added in v0.5.4 

type SessionDeleteRequest struct {
	// Target session ID, from the list returned by `POST /safari/session/list`.
	SessionID string `json:"session_id" toon:"session_id"`
}

SessionDeleteRequest is generated from the Flashduty OpenAPI schema.

type SessionExportRequest added in v0.5.4 

type SessionExportRequest struct {
	// When true, each subagent_dispatch line is followed by the child session's full event stream, bracketed by its own session_meta. Defaults to false.
	IncludeSubagents bool `json:"include_subagents,omitempty" toon:"include_subagents,omitempty"`
	// Target session ID, from the list returned by `POST /safari/session/list`.
	SessionID string `json:"session_id" toon:"session_id"`
}

SessionExportRequest is generated from the Flashduty OpenAPI schema.

type SessionGetRequest added in v0.5.4 

type SessionGetRequest struct {
	// Page size for events; takes precedence over `num_recent_events`. 0 uses the server default (100).
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
	// Legacy page size: number of most-recent events to return. Superseded by `limit` when both are set; 0 uses the server default (100).
	NumRecentEvents int64 `json:"num_recent_events,omitempty" toon:"num_recent_events,omitempty"`
	// Opaque keyset cursor from a previous response; pass it back to fetch the next older page.
	SearchAfterCtx string `json:"search_after_ctx,omitempty" toon:"search_after_ctx,omitempty"`
	// Target session ID, from the list returned by `POST /safari/session/list`.
	SessionID string `json:"session_id" toon:"session_id"`
	// Share token for accessing a session through its share link. Omit it for normal account-authorized access.
	ShareToken string `json:"share_token,omitempty" toon:"share_token,omitempty"`
}

SessionGetRequest is generated from the Flashduty OpenAPI schema.

type SessionGetResponse added in v0.5.4 

type SessionGetResponse struct {
	// Recent events, ascending by (created_at, event_id).
	Events []EventItem `json:"events" toon:"events"`
	// True when older events remain beyond this page.
	HasMoreOlder bool `json:"has_more_older" toon:"has_more_older"`
	// Opaque keyset cursor; pass back as search_after_ctx to fetch the next older page. Omitted when has_more_older is false.
	SearchAfterCtx string      `json:"search_after_ctx" toon:"search_after_ctx"`
	Session        SessionItem `json:"session" toon:"session"`
	// Account-wide onboarding flag: true when the account has zero knowledge packs in any scope; not specific to this session.
	SuggestInit bool `json:"suggest_init" toon:"suggest_init"`
}

SessionGetResponse is generated from the Flashduty OpenAPI schema.

type SessionItem added in v0.5.4 

type SessionItem struct {
	// How the caller received access to this session. Omitted when no access source is resolved. One of:
	// | Value | Meaning |
	// | --- | --- |
	// | `owner` | Caller is the session creator (full access) |
	// | `team_member` | Caller belongs to the session's bound team (full access) |
	// | `manager` | Manager grant (reserved; never produced by the current version) |
	// | `share_link` | Granted via a valid share link (view/fork only; cannot continue or manage) |
	// | `participant` | Same-account non-member granted via a participable team session (view/continue/fork only) |
	AccessSource string `json:"access_source" toon:"access_source"`
	// Agent app that owns the session.
	AppName string `json:"app_name" toon:"app_name"`
	// Unix timestamp in milliseconds when archived; 0 means not archived.
	ArchivedAt       TimestampMilli     `json:"archived_at" toon:"archived_at"`
	BoundEnvironment EnvironmentBinding `json:"bound_environment" toon:"bound_environment"`
	// True when the caller can add a new turn to this session.
	CanContinue bool `json:"can_continue" toon:"can_continue"`
	// True when the caller can fork this session.
	CanFork bool `json:"can_fork" toon:"can_fork"`
	// True when the caller may rename/archive/delete the session; personal sessions are creator-only, team sessions allow the creator, account admin, or team member.
	CanManage bool `json:"can_manage" toon:"can_manage"`
	// True when the caller can view this session.
	CanView         bool                `json:"can_view" toon:"can_view"`
	ContextResolved ContextResolvedItem `json:"context_resolved" toon:"context_resolved"`
	// The bound model's max context size in tokens. 0 means unknown.
	ContextWindow int64 `json:"context_window" toon:"context_window"`
	// Unix timestamp in milliseconds when the session was created.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Size in tokens of the LLM context window as of the most recent turn. 0 means no turn has completed.
	CurrentContextTokens int64 `json:"current_context_tokens" toon:"current_context_tokens"`
	// Active working duration in milliseconds for the current or most recent round, excluding time spent waiting on ask_user; resets to 0 at the start of each new round.
	CurrentTurnActiveMs int64 `json:"current_turn_active_ms" toon:"current_turn_active_ms"`
	// Unix timestamp in milliseconds when the current or most recent round started; 0 if no round has started yet.
	CurrentTurnStartedAt TimestampMilli `json:"current_turn_started_at" toon:"current_turn_started_at"`
	// Total tokens (input+output+reasoning) for the in-flight round across the parent and its subagents; only computed by session/get while the session is running, always 0 in session/list responses and when idle.
	CurrentTurnTokens int64 `json:"current_turn_tokens" toon:"current_turn_tokens"`
	// Accumulated ask_user human-wait duration in milliseconds for the current round; resets to 0 at the start of each new round.
	CurrentTurnWaitMs int64 `json:"current_turn_wait_ms" toon:"current_turn_wait_ms"`
	// Surface that created the session. One of:
	// | Value | Meaning |
	// | --- | --- |
	// | `web` | Created from the web console |
	// | `im` | Created from an IM client (IM bot / IM H5) |
	// | `api` | Created via the public API |
	// | `automation` | Created by an automation rule (unattended run) |
	// | `subagent` | Child session spawned by a parent's agent_dispatch (audit label; at runtime it executes on the web tool surface) |
	EntryKind string `json:"entry_kind" toon:"entry_kind"`
	// True when there is assistant output the caller has not yet viewed.
	HasUnread bool `json:"has_unread" toon:"has_unread"`
	// True for incognito (non-persisted-memory) sessions.
	Incognito bool `json:"incognito" toon:"incognito"`
	// True when the caller created this session.
	IsMine bool `json:"is_mine" toon:"is_mine"`
	// True when an agent turn is currently in flight for this session.
	IsRunning bool `json:"is_running" toon:"is_running"`
	// Unix timestamp in milliseconds of the most recent assistant-side event.
	LastEventAt TimestampMilli `json:"last_event_at" toon:"last_event_at"`
	// Parent session id for subagent (child) sessions; empty otherwise.
	ParentSessionID string `json:"parent_session_id" toon:"parent_session_id"`
	// Creator person id.
	PersonID string `json:"person_id" toon:"person_id"`
	// Caller's per-user pin time as a Unix timestamp in milliseconds; 0 means not pinned.
	PinnedAt TimestampMilli `json:"pinned_at" toon:"pinned_at"`
	// Session identifier.
	SessionID string `json:"session_id" toon:"session_id"`
	// Session title; may be empty for untitled sessions.
	SessionName string `json:"session_name" toon:"session_name"`
	// True when the session's share link is active.
	ShareEnabled bool `json:"share_enabled" toon:"share_enabled"`
	// Revision of the share link; it increases when sharing is revoked.
	ShareVersion int64 `json:"share_version" toon:"share_version"`
	// Unix timestamp in milliseconds when sharing was last enabled; 0 if never shared.
	SharedAt TimestampMilli `json:"shared_at" toon:"shared_at"`
	// Person ID that most recently enabled sharing; 0 if never shared.
	SharedBy int64 `json:"shared_by" toon:"shared_by"`
	// Raw session-state bag (session-scoped keys). Omitted when empty.
	State map[string]any `json:"state" toon:"state"`
	// Lifecycle status. One of: `enabled` (active), `deleted` (soft-deleted, no longer accessible).
	Status string `json:"status" toon:"status"`
	// Owning team id; 0 means no team is bound. Immutable after create.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Resolved team name; empty for unbound rows or deleted teams.
	TeamName string `json:"team_name" toon:"team_name"`
	// Current save→validate round id (template-assistant only); empty otherwise.
	TemplateStagingRoundID string            `json:"template_staging_round_id" toon:"template_staging_round_id"`
	TokenUsage             SessionTokenUsage `json:"token_usage" toon:"token_usage"`
	// Unix timestamp in milliseconds of the last session update.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
}

SessionItem is generated from the Flashduty OpenAPI schema.

type SessionListRequest added in v0.5.4 

type SessionListRequest struct {
	ListOptions
	// Agent app whose sessions to list. One of:
	// | Value | Meaning |
	// | --- | --- |
	// | `ask-ai` | Ask AI assistant |
	// | `support` | Customer-support agent |
	// | `support-website` | Website support agent (exposed over A2A, not built into the console) |
	// | `support-flashcat` | Flashcat-site support agent (exposed over A2A) |
	// | `ai-sre` | The AI SRE main app |
	// | `template-assistant` | Notification-template assistant (template editing/validation) |
	// | `swe` | Internal benchmarking app (not customer-facing) |
	AppName string `json:"app_name" toon:"app_name"`
	// Ascending order when true, descending when false. Only honored together with `orderby`; when `orderby` is omitted the sort is always `updated_at` descending.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Restrict to sessions produced by these surfaces; empty returns every kind.
	EntryKinds []string `json:"entry_kinds,omitempty" toon:"entry_kinds,omitempty"`
	// Include subagent-dispatched sessions in the list.
	IncludeSubagentSessions bool `json:"include_subagent_sessions,omitempty" toon:"include_subagent_sessions,omitempty"`
	// Filter by session-name keyword.
	Keyword string `json:"keyword,omitempty" toon:"keyword,omitempty"`
	// Sort field: `created_at` by creation time, `updated_at` by last update; defaults to `updated_at` when omitted.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Visibility scope: `all` (own personal + accessible team sessions), `personal`, or `team`; default `all`.
	Scope string `json:"scope,omitempty" toon:"scope,omitempty"`
	// Archive bucket: active (default) returns un-archived, archived returns archived, all returns both.
	Status string `json:"status,omitempty" toon:"status,omitempty"`
	// Optional explicit team filter; intersects with `scope` and never expands access.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

SessionListRequest is generated from the Flashduty OpenAPI schema.

type SessionListResponse added in v0.5.4 

type SessionListResponse struct {
	// The page of sessions.
	Sessions []SessionItem `json:"sessions" toon:"sessions"`
	// Account-wide onboarding flag: true when the account has zero knowledge packs in any scope; not dependent on this call's filters.
	SuggestInit bool `json:"suggest_init" toon:"suggest_init"`
	// Total number of sessions matching the filter (ignoring pagination).
	Total int64 `json:"total" toon:"total"`
}

SessionListResponse is generated from the Flashduty OpenAPI schema.

type SessionReplayService added in v0.5.7 

type SessionReplayService service

SessionReplayService handles the "RUM/Session replay" API resource.

func (*SessionReplayService) Metadata added in v0.5.7 

func (s *SessionReplayService) Metadata(ctx context.Context, req *RUMSessionReplayMetaRequest) (*RUMSessionReplayMetaItem, *Response, error)

Get session replay metadata.

Return the application, device, session bounds, and views recorded for a replayable session.

API: POST /rum/session-replay/metadata (rum-session-replay-read-metadata).

func (*SessionReplayService) Segments added in v0.5.7 

func (s *SessionReplayService) Segments(ctx context.Context, req *RUMSessionReplaySegmentsRequest) (*RUMSessionReplaySegmentsResult, *Response, error)

List session replay segments.

Page through the recorded replay segments of a session, as presigned URLs or a raw stream.

API: POST /rum/session-replay/segments (rum-session-replay-read-segments).

type SessionTokenUsage added in v0.5.4 

type SessionTokenUsage struct {
	// Portion of input_tokens served from the prompt cache.
	CachedTokens int64 `json:"cached_tokens" toon:"cached_tokens"`
	// Total prompt (input) tokens, including the cached portion.
	InputTokens int64 `json:"input_tokens" toon:"input_tokens"`
	// Total generated (output) tokens.
	OutputTokens int64 `json:"output_tokens" toon:"output_tokens"`
	// Total reasoning/thinking tokens.
	ReasoningTokens int64 `json:"reasoning_tokens" toon:"reasoning_tokens"`
}

SessionTokenUsage is generated from the Flashduty OpenAPI schema.

type SessionsService added in v0.5.4 

type SessionsService service

SessionsService handles the "AI SRE/Sessions" API resource.

func (*SessionsService) Export added in v0.5.4 

func (s *SessionsService) Export(ctx context.Context, req *SessionExportRequest) (io.ReadCloser, *Response, error)

Export streams a session's full event transcript as newline-delimited JSON (application/x-ndjson). The first line is always a session_meta envelope; subsequent lines are session events. When req.IncludeSubagents is true, each subagent_dispatch line is followed by the child session's own stream.

Unlike the generated typed endpoints, the success body is NOT a JSON envelope: it is a potentially large line-delimited stream meant to be written straight to a file. The returned io.ReadCloser is the live HTTP response body — the caller owns it and MUST Close it (a deferred close is correct). Parse it line-by-line (see NewExportScanner / DecodeExportLine); do not buffer the whole transcript into memory.

On any non-2xx status the body is the usual JSON error envelope: Export reads and closes it and returns a typed error (*ErrorResponse, or *RateLimitError on 429) with a nil ReadCloser, matching the generated endpoints.

API: POST /safari/session/export (session-read-export).

func (*SessionsService) ReadInfo added in v0.5.4 

func (s *SessionsService) ReadInfo(ctx context.Context, req *SessionGetRequest) (*SessionGetResponse, *Response, error)

Get session detail.

Fetch one session plus a backward-paged window of its most recent events.

API: POST /safari/session/get (session-read-info).

func (*SessionsService) ReadList added in v0.5.4 

func (s *SessionsService) ReadList(ctx context.Context, req *SessionListRequest) (*SessionListResponse, *Response, error)

List sessions.

List agent sessions visible to the caller, filtered by app, surface, archive status, and team.

API: POST /safari/session/list (session-read-list).

func (*SessionsService) WriteDelete added in v0.5.4 

func (s *SessionsService) WriteDelete(ctx context.Context, req *SessionDeleteRequest) (*any, *Response, error)

Delete session.

Delete a session by ID.

API: POST /safari/session/delete (session-write-delete).

type SignedUrLs added in v0.14.5 

type SignedUrLs struct {
	// MIME type of the file.
	ContentType string `json:"content_type" toon:"content_type"`
	// Relative URL (`/safari/artifact/stream?...`) that serves the file as an attachment. Prepend the API base `https://api.flashcat.cloud` before use; expires with `expires_in`.
	DownloadURL string `json:"download_url" toon:"download_url"`
	// Validity of both URLs in seconds (300).
	ExpiresIn int64 `json:"expires_in" toon:"expires_in"`
	// File name including extension.
	Name string `json:"name" toon:"name"`
	// Same as `download_url` but served inline for browser preview.
	PreviewURL string `json:"preview_url" toon:"preview_url"`
	// File size in bytes.
	Size int64 `json:"size" toon:"size"`
}

SignedUrLs is generated from the Flashduty OpenAPI schema.

type SilenceRuleItem 

type SilenceRuleItem struct {
	// ID of the account the rule belongs to.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// ID of the channel the rule belongs to.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Creation time, Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Deletion time, Unix timestamp in seconds. Omitted unless the rule is soft-deleted; deleted rules are excluded from list responses.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Rule description.
	Description string `json:"description" toon:"description"`
	// Alert event match conditions; matching events are silenced within the time window.
	Filters FilterGroup `json:"filters" toon:"filters"`
	// Incident the rule is attached to. Always present; the zero ObjectID `000000000000000000000000` means the rule was not created from an incident.
	FromIncidentID string `json:"from_incident_id" toon:"from_incident_id"`
	// When true, the silence rule is automatically deleted after its time window expires. Defaults to false.
	IsAutoDelete bool `json:"is_auto_delete" toon:"is_auto_delete"`
	// When true, silenced alerts are dropped instead of suppressed into incidents.
	IsDirectlyDiscard bool `json:"is_directly_discard" toon:"is_directly_discard"`
	// Whether the rule's time window covers the current moment, evaluated at response time.
	IsEffective bool `json:"is_effective" toon:"is_effective"`
	// Rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Rule status: `enabled` or `disabled`; deleted rules never appear in the list.
	Status string `json:"status" toon:"status"`
	// One-off silence window. Present with zero values when the rule uses recurring `time_filters` instead.
	TimeFilter OnceTimeFilter `json:"time_filter" toon:"time_filter"`
	// Recurring silence windows. Empty when the rule uses a one-off `time_filter`.
	TimeFilters []TimeFilter `json:"time_filters" toon:"time_filters"`
	// Last update time, Unix timestamp in seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// ID of the user who last updated the rule.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

SilenceRuleItem is generated from the Flashduty OpenAPI schema.

type SkillDeleteRequest added in v0.4.0 

type SkillDeleteRequest struct {
	// Target skill ID, from the list returned by `POST /safari/skill/list`.
	SkillID string `json:"skill_id" toon:"skill_id"`
}

SkillDeleteRequest is generated from the Flashduty OpenAPI schema.

type SkillGetRequest added in v0.4.0 

type SkillGetRequest struct {
	// Target skill ID, from the list returned by `POST /safari/skill/list`.
	SkillID string `json:"skill_id" toon:"skill_id"`
}

SkillGetRequest is generated from the Flashduty OpenAPI schema.

type SkillItem added in v0.4.0 

type SkillItem struct {
	// Owning account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Skill author.
	Author string `json:"author" toon:"author"`
	// Whether the caller may edit this skill.
	CanEdit bool `json:"can_edit" toon:"can_edit"`
	// SHA-256 checksum of the skill zip.
	Checksum string `json:"checksum" toon:"checksum"`
	// Full SKILL.md content. Omitted in list responses.
	Content string `json:"content" toon:"content"`
	// Set only on install-from-session responses: true = fresh install, false = in-place update.
	Created bool `json:"created" toon:"created"`
	// Creation time. Unix timestamp in milliseconds.
	CreatedAt TimestampMilli `json:"created_at" toon:"created_at"`
	// Member ID that created the skill.
	CreatedBy int64 `json:"created_by" toon:"created_by"`
	// Human-readable description from the SKILL.md frontmatter.
	Description string `json:"description" toon:"description"`
	// Optional English description. English-locale UI responses prefer this over `description`; the skill catalog also uses it as a stable selection signal when `description` is localized for display.
	DescriptionEn string `json:"description_en" toon:"description_en"`
	// True when a marketplace-sourced skill was edited locally (auto-update skips it).
	IsModified bool `json:"is_modified" toon:"is_modified"`
	// Skill license.
	License string `json:"license" toon:"license"`
	// Object-storage key of the skill zip.
	S3Key string `json:"s3_key" toon:"s3_key"`
	// Unique skill ID (prefix `skill_`).
	SkillID string `json:"skill_id" toon:"skill_id"`
	// Skill name, unique within its scope (account-wide or within one team).
	SkillName string `json:"skill_name" toon:"skill_name"`
	// Marketplace template this skill was installed from; empty for user-authored.
	SourceTemplateName string `json:"source_template_name" toon:"source_template_name"`
	// Template version at install time.
	SourceTemplateVersion string `json:"source_template_version" toon:"source_template_version"`
	// Skill status. Deleted skills are excluded from every API response, so only these two values are ever returned.
	Status string `json:"status" toon:"status"`
	// Tags parsed from the frontmatter.
	Tags []string `json:"tags" toon:"tags"`
	// Team scope: 0 = account-wide; >0 = the owning team.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Required tools (builtin or `mcp:server/tool`).
	Tools []string `json:"tools" toon:"tools"`
	// True when the marketplace has a newer template version.
	UpdateAvailable bool `json:"update_available" toon:"update_available"`
	// Last update time. Unix timestamp in milliseconds.
	UpdatedAt TimestampMilli `json:"updated_at" toon:"updated_at"`
	// Execution-environment kinds (EnvironmentKind strings, e.g. `byoc`) the skill is restricted to. Omitted when empty, which means the skill is available in all venues.
	Venues []string `json:"venues" toon:"venues"`
	// Skill version from the frontmatter.
	Version string `json:"version" toon:"version"`
}

SkillItem is generated from the Flashduty OpenAPI schema.

type SkillListRequest added in v0.4.0 

type SkillListRequest struct {
	ListOptions
	// Include account-scoped (team_id=0) rows. Defaults to true. Ignored when `scope` is `account` or `team`.
	IncludeAccount *bool `json:"include_account,omitempty" toon:"include_account,omitempty"`
	// Free-text search across skill name, description, English description, skill ID, marketplace source template name, and author.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Restrict results to `all` (default), `account`-only (team_id=0), or `team`-only (excludes account-scoped rows). Overrides `include_account` when set.
	Scope string `json:"scope,omitempty" toon:"scope,omitempty"`
	// Filter to these team IDs; empty = the caller's visible set.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

SkillListRequest is generated from the Flashduty OpenAPI schema.

type SkillListResponse added in v0.4.0 

type SkillListResponse struct {
	// Skills on this page.
	Skills []SkillItem `json:"skills" toon:"skills"`
	// Total number of matching skills.
	Total int64 `json:"total" toon:"total"`
}

SkillListResponse is generated from the Flashduty OpenAPI schema.

type SkillStatusRequest added in v0.4.0 

type SkillStatusRequest struct {
	// Target skill ID, from the list returned by `POST /safari/skill/list`.
	SkillID string `json:"skill_id" toon:"skill_id"`
}

SkillStatusRequest is generated from the Flashduty OpenAPI schema.

type SkillUpdateRequest added in v0.4.0 

type SkillUpdateRequest struct {
	// New description. Cannot contain `<` or `>`. Sending an empty string leaves the current value unchanged — there is no way to clear it via this field.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// New English description. Cannot contain `<` or `>`. Omit to leave unchanged; send an empty string to explicitly clear it.
	DescriptionEn *string `json:"description_en,omitempty" toon:"description_en,omitempty"`
	// Target skill ID, from the list returned by `POST /safari/skill/list`.
	SkillID string `json:"skill_id" toon:"skill_id"`
	// Reassign team scope: 0 = account-wide; >0 = team. Omit to leave unchanged.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
}

SkillUpdateRequest is generated from the Flashduty OpenAPI schema.

type SkillUploadRequest added in v0.5.4 

type SkillUploadRequest struct {
	// File is the skill archive (.skill / .zip / .tar.gz / .tgz). Required.
	// Max 100 MB; oversized files are rejected before the body is read.
	File io.Reader
	// Filename is the multipart file name; defaults to "skill.zip".
	Filename string
	// TeamID scopes the created/upserted skill: 0 (default) = account-wide.
	// Ignored when replacing a specific skill via SkillID.
	TeamID int64
	// Replace overwrites an existing skill instead of failing on a name
	// collision — matched by SkillID if provided, otherwise by skill name.
	Replace bool
	// SkillID targets an existing skill when replacing (requires Replace).
	SkillID string
}

SkillUploadRequest carries the skill archive and options for WriteUpload. It is hand-written rather than generated because the endpoint consumes multipart/form-data, which the generated JSON request path cannot encode.

type SkillsService added in v0.4.0 

type SkillsService service

SkillsService handles the "AI SRE/Skills" API resource.

func (*SkillsService) ReadEnable added in v0.4.0 

func (s *SkillsService) ReadEnable(ctx context.Context, req *SkillStatusRequest) (*any, *Response, error)

Enable skill.

Enable a disabled skill so the agent can load it.

API: POST /safari/skill/enable (skill-read-enable).

func (*SkillsService) ReadGet added in v0.4.0 

func (s *SkillsService) ReadGet(ctx context.Context, req *SkillGetRequest) (*SkillItem, *Response, error)

Get skill detail.

Get one skill including its full SKILL.md content.

API: POST /safari/skill/get (skill-read-get).

func (*SkillsService) ReadList added in v0.4.0 

func (s *SkillsService) ReadList(ctx context.Context, req *SkillListRequest) (*SkillListResponse, *Response, error)

List skills.

List AI SRE skills visible to the caller across account and team scopes, with pagination.

API: POST /safari/skill/list (skill-read-list).

func (*SkillsService) WriteDelete added in v0.4.0 

func (s *SkillsService) WriteDelete(ctx context.Context, req *SkillDeleteRequest) (*any, *Response, error)

Delete skill.

Delete a skill by ID.

API: POST /safari/skill/delete (skill-write-delete).

func (*SkillsService) WriteDisable added in v0.4.0 

func (s *SkillsService) WriteDisable(ctx context.Context, req *SkillStatusRequest) (*any, *Response, error)

Disable skill.

Disable an enabled skill so the agent stops loading it.

API: POST /safari/skill/disable (skill-write-disable).

func (*SkillsService) WriteUpdate added in v0.4.0 

func (s *SkillsService) WriteUpdate(ctx context.Context, req *SkillUpdateRequest) (*SkillItem, *Response, error)

Update skill.

Update a skill's descriptions or reassign its team scope.

API: POST /safari/skill/update (skill-write-update).

func (*SkillsService) WriteUpload added in v0.4.0 

func (s *SkillsService) WriteUpload(ctx context.Context, req *SkillUploadRequest) (*SkillItem, *Response, error)

WriteUpload uploads a skill archive to create or replace a skill.

API: POST /safari/skill/upload (skill-write-upload).

type SnoozeIncidentRequest 

type SnoozeIncidentRequest struct {
	// Incident IDs to snooze. At most 100 per call.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
	// Duration in minutes. Must be greater than 0 and at most 43,200 (30 days).
	Minutes int64 `json:"minutes" toon:"minutes"`
}

SnoozeIncidentRequest is generated from the Flashduty OpenAPI schema.

type SourcemapBinaryImage added in v0.5.4 

type SourcemapBinaryImage struct {
	// CPU architecture for this binary image.
	Arch string `json:"arch,omitempty" toon:"arch,omitempty"`
	// Whether this binary belongs to the operating system.
	IsSystem bool `json:"is_system" toon:"is_system"`
	// Runtime address. Accepts a hex string such as `0x100000000` or a decimal integer.
	LoadAddress any `json:"load_address,omitempty" toon:"load_address,omitempty"`
	// Runtime address. Accepts a hex string such as `0x100000000` or a decimal integer.
	MaxAddress any `json:"max_address,omitempty" toon:"max_address,omitempty"`
	// Binary image name.
	Name string `json:"name" toon:"name"`
	// Build UUID identifying the binary or dSYM.
	Uuid string `json:"uuid" toon:"uuid"`
}

SourcemapBinaryImage is generated from the Flashduty OpenAPI schema.

type SourcemapCodeSnippet added in v0.5.4 

type SourcemapCodeSnippet struct {
	// Source code on that line.
	Code string `json:"code" toon:"code"`
	// Source line number.
	Line int64 `json:"line" toon:"line"`
}

SourcemapCodeSnippet is generated from the Flashduty OpenAPI schema.

type SourcemapEnrichedFrame added in v0.5.4 

type SourcemapEnrichedFrame struct {
	// iOS or native memory address.
	Address string `json:"address" toon:"address"`
	// Android Java/Kotlin class name.
	ClassName string `json:"class_name" toon:"class_name"`
	// Source-code snippets around this frame. Omitted when no snippet was extracted (for example the source content was unavailable or `near` was not requested).
	CodeSnippets []SourcemapCodeSnippet `json:"code_snippets" toon:"code_snippets"`
	// Column number for JavaScript or Flutter frames.
	Column int64 `json:"column" toon:"column"`
	// Whether the frame was successfully symbolicated or deobfuscated.
	Converted bool `json:"converted" toon:"converted"`
	// Source file, URL, or module path.
	File string `json:"file" toon:"file"`
	// Function or method name.
	Function string `json:"function" toon:"function"`
	// Line number.
	Line int64 `json:"line" toon:"line"`
	// Android Java/Kotlin method name without class prefix.
	MethodName string `json:"method_name" toon:"method_name"`
	// iOS Swift/Objective-C module name.
	Module string `json:"module" toon:"module"`
	// Unity IL native address.
	NativeAddress string `json:"native_address" toon:"native_address"`
	// Symbol offset from function start.
	Offset int64 `json:"offset" toon:"offset"`
	// The original minified/obfuscated frame before enrichment. Omitted when the processor did not retain one.
	OriginalFrame SourcemapStackFrame `json:"original_frame" toon:"original_frame"`
	// Whether the frame is from third-party or system libraries (Android and native symbolication only). Omitted when `false`.
	ThirdParty bool `json:"third_party" toon:"third_party"`
}

SourcemapEnrichedFrame is generated from the Flashduty OpenAPI schema.

type SourcemapItem 

type SourcemapItem struct {
	// Upload timestamp, Unix epoch seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Git commit SHA for this build.
	GitCommitSHA string `json:"git_commit_sha" toon:"git_commit_sha"`
	// Git repository URL associated with this build.
	GitRepositoryURL string `json:"git_repository_url" toon:"git_repository_url"`
	// Storage key uniquely identifying this sourcemap file.
	Key string `json:"key" toon:"key"`
	// Platform-specific metadata: `minified_url` (browser/react-native/harmony/miniprogram); `build_id`, `variant`, `version_code` (android mappings), plus `arch`, `lib_name`, `code_id` (android/harmony/electron native symbols); `uuid` (ios); `build_id`, `platform`, `arch`, `flavor`, `code_id`, `debug_id` (flutter); `subpackage`, `minified_url` (miniprogram). Omitted when empty.
	Metadata map[string]any `json:"metadata" toon:"metadata"`
	// Deprecated. Storage path of the minified file; present only on JavaScript records.
	MinifiedPath string `json:"minified_path" toon:"minified_path"`
	// Deprecated. URL of the minified file; present only on JavaScript and miniprogram records. New integrations should read `metadata.minified_url`.
	MinifiedURL string `json:"minified_url" toon:"minified_url"`
	// Application or service name.
	Service string `json:"service" toon:"service"`
	// File size in bytes.
	Size int64 `json:"size" toon:"size"`
	// Deprecated. Storage path of the sourcemap file; present only on JavaScript and miniprogram records.
	SourcemapPath string `json:"sourcemap_path" toon:"sourcemap_path"`
	// Platform store this record belongs to. JavaScript rows always report `browser` (including HarmonyOS ArkTS and React Native uploads); native-symbol rows always report `android` (including HarmonyOS native and Electron uploads).
	//
	// | Value | Store |
	// |---|---|
	// | `browser` | JavaScript sourcemap store |
	// | `android` | Android mapping store, or the shared native symbol store |
	// | `ios` | iOS dSYM store |
	// | `miniprogram` | WeChat mini program sourcemap store |
	// | `flutter` | Flutter Dart AOT symbol store |
	Type string `json:"type" toon:"type"`
	// Last update timestamp, Unix epoch seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Application version string.
	Version string `json:"version" toon:"version"`
}

SourcemapItem is generated from the Flashduty OpenAPI schema.

type SourcemapListRequest 

type SourcemapListRequest struct {
	ListOptions
	// Sort ascending. Default false (descending).
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Android only. Filter by Gradle plugin build identifier. Max 200 characters.
	BuildID string `json:"build_id,omitempty" toon:"build_id,omitempty"`
	// End of upload time range, Unix epoch milliseconds. Maximum window: 365 days.
	EndTime int64 `json:"end_time" toon:"end_time"`
	// Symbol type filter, Android and HarmonyOS only (ignored for other platforms): `mapping` (default) lists ProGuard/R8 mappings or ArkTS sourcemaps, `native` lists native .so symbols.
	Kind string `json:"kind,omitempty" toon:"kind,omitempty"`
	// Sort field; defaults to `created_at` descending when omitted.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Free-text substring match. Matches `minified_url` for the JS stores (browser/react-native/harmony/miniprogram), `build_id` for android/flutter/electron and harmony with `kind=native`, or `uuid` for ios (case-insensitive, hyphens ignored).
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by service names. Up to 100 values.
	Services []string `json:"services,omitempty" toon:"services,omitempty"`
	// Start of upload time range, Unix epoch milliseconds. Must be > 0 and before `end_time`.
	StartTime int64 `json:"start_time" toon:"start_time"`
	// Platform whose symbol store to list. Defaults to `browser` when omitted; any other value returns an empty list.
	//
	// | Value | Store listed |
	// |---|---|
	// | `browser` | JavaScript sourcemaps (shared store; excludes HarmonyOS ArkTS and React Native rows) |
	// | `android` | ProGuard/R8 mapping files; with `kind=native`, Android NDK .so symbols |
	// | `ios` | iOS dSYM symbol files |
	// | `miniprogram` | WeChat mini program sourcemaps |
	// | `react-native` | React Native JS sourcemaps |
	// | `harmony` | HarmonyOS ArkTS sourcemaps; with `kind=native`, HarmonyOS .so symbols |
	// | `flutter` | Flutter Dart AOT symbols |
	// | `electron` | Electron Breakpad symbols |
	Type string `json:"type,omitempty" toon:"type,omitempty"`
	// iOS only. Filter by dSYM bundle UUID. Max 200 characters.
	Uuid string `json:"uuid,omitempty" toon:"uuid,omitempty"`
	// Filter by version strings. Up to 100 values.
	Versions []string `json:"versions,omitempty" toon:"versions,omitempty"`
}

SourcemapListRequest is generated from the Flashduty OpenAPI schema.

type SourcemapListResponse 

type SourcemapListResponse struct {
	// Sourcemap records of the current page. Omitted when empty.
	Items []SourcemapItem `json:"items" toon:"items"`
	// Total number of matching records. Omitted when 0.
	Total int64 `json:"total" toon:"total"`
}

SourcemapListResponse is generated from the Flashduty OpenAPI schema.

type SourcemapStackEnrichRequest added in v0.5.4 

type SourcemapStackEnrichRequest struct {
	// Android NDK architecture such as `arm`, `arm64`, `x86`, or `x64`.
	Arch string `json:"arch,omitempty" toon:"arch,omitempty"`
	// Loaded binary images from an iOS crash report.
	BinaryImages []SourcemapBinaryImage `json:"binary_images,omitempty" toon:"binary_images,omitempty"`
	// Android build ID for Gradle plugin 1.13.0 and later.
	BuildID string `json:"build_id,omitempty" toon:"build_id,omitempty"`
	// Number of nearby meaningful source lines to return around converted frames.
	Near int64 `json:"near,omitempty" toon:"near,omitempty"`
	// Skip cached enrich results. Intended for debugging.
	NoCache bool `json:"no_cache,omitempty" toon:"no_cache,omitempty"`
	// Narrows a `react-native` enrich to the app's native platform: `ios` for the iOS native layer, `android` for the Android native layer (the console derives it from the event's OS). Ignored for other `type` values.
	Platform string `json:"platform,omitempty" toon:"platform,omitempty"`
	// Application or service name used when the sourcemap was uploaded.
	Service string `json:"service" toon:"service"`
	// Android error source type. Use `ndk` with `arch` for native symbolication.
	SourceType string `json:"source_type,omitempty" toon:"source_type,omitempty"`
	// Raw stack trace to parse and enrich.
	Stack string `json:"stack,omitempty" toon:"stack,omitempty"`
	// Source platform whose symbol store is used. Defaults to `browser` when omitted.
	//
	// | Value | Symbolication |
	// |---|---|
	// | `browser` | JavaScript stacks via sourcemaps |
	// | `android` | Java/Kotlin stacks via ProGuard/R8 mappings; native stacks via NDK symbols (send `source_type=ndk` with `arch`) |
	// | `ios` | iOS crash stacks via dSYM (send `binary_images`) |
	// | `miniprogram` | WeChat mini program stacks via sourcemaps |
	// | `harmony` | HarmonyOS stacks via ArkTS sourcemaps or native symbols |
	// | `flutter` | Flutter/Dart stacks via Dart AOT symbols |
	// | `electron` | Electron JavaScript stacks via sourcemaps; minidump native frames via Breakpad symbols (derived from `source_type`) |
	// | `react-native` | React Native JS stacks via sourcemaps; narrow the lookup with `platform` |
	Type string `json:"type,omitempty" toon:"type,omitempty"`
	// Android build variant used by older Gradle plugin versions.
	Variant string `json:"variant,omitempty" toon:"variant,omitempty"`
	// Application version used when the sourcemap was uploaded.
	Version string `json:"version" toon:"version"`
}

SourcemapStackEnrichRequest is generated from the Flashduty OpenAPI schema.

type SourcemapStackEnrichResponse added in v0.5.4 

type SourcemapStackEnrichResponse struct {
	// Error stack frames after symbolication (via sourcemap, dSYM, NDK symbol tables, etc.).
	Frames []SourcemapEnrichedFrame `json:"frames" toon:"frames"`
}

SourcemapStackEnrichResponse is generated from the Flashduty OpenAPI schema.

type SourcemapStackFrame added in v0.5.4 

type SourcemapStackFrame struct {
	// iOS or native memory address.
	Address string `json:"address" toon:"address"`
	// Android Java/Kotlin class name.
	ClassName string `json:"class_name" toon:"class_name"`
	// Column number for JavaScript or Flutter frames.
	Column int64 `json:"column" toon:"column"`
	// Source file, URL, or module path.
	File string `json:"file" toon:"file"`
	// Function or method name.
	Function string `json:"function" toon:"function"`
	// Line number.
	Line int64 `json:"line" toon:"line"`
	// Android Java/Kotlin method name without class prefix.
	MethodName string `json:"method_name" toon:"method_name"`
	// iOS Swift/Objective-C module name.
	Module string `json:"module" toon:"module"`
	// Unity IL native address.
	NativeAddress string `json:"native_address" toon:"native_address"`
	// Symbol offset from function start.
	Offset int64 `json:"offset" toon:"offset"`
}

SourcemapStackFrame is generated from the Flashduty OpenAPI schema.

type SourcemapsService 

type SourcemapsService service

SourcemapsService handles the "RUM/Sourcemaps" API resource.

func (*SourcemapsService) List 

func (s *SourcemapsService) List(ctx context.Context, req *SourcemapListRequest) (*SourcemapListResponse, *Response, error)

List sourcemaps.

Return a paginated list of uploaded sourcemap files filtered by platform type, service, and version.

API: POST /sourcemap/list (sourcemap-read-list).

func (*SourcemapsService) StackEnrich added in v0.5.4 

func (s *SourcemapsService) StackEnrich(ctx context.Context, req *SourcemapStackEnrichRequest) (*SourcemapStackEnrichResponse, *Response, error)

Enrich a stack trace.

Symbolicate or deobfuscate a browser, Android, iOS, Mini Program, or HarmonyOS stack trace.

API: POST /sourcemap/stack/enrich (sourcemap-read-stack-enrich).

type StatusPageChangeCreateResponse 

type StatusPageChangeCreateResponse struct {
	// Newly created event ID.
	ChangeID int64 `json:"change_id" toon:"change_id"`
	// Event title (echoed from the request).
	ChangeName string `json:"change_name" toon:"change_name"`
}

StatusPageChangeCreateResponse is generated from the Flashduty OpenAPI schema.

type StatusPageChangeItem 

type StatusPageChangeItem struct {
	// Components currently affected by this event, with their resulting status. Omitted when no components are affected.
	AffectedComponents []AffectedStatusPageComponentItem `json:"affected_components" toon:"affected_components"`
	// Maintenance only: whether the status advances automatically based on the scheduled window. Omitted when false.
	AutoUpdateBySchedule bool `json:"auto_update_by_schedule" toon:"auto_update_by_schedule"`
	// Event ID.
	ChangeID int64 `json:"change_id" toon:"change_id"`
	// Event close time in Unix seconds. For maintenances this is the scheduled end time; for closed events, the time the event reached its terminal status (`resolved`/`completed`). Omitted when not set.
	CloseAtSeconds Timestamp `json:"close_at_seconds" toon:"close_at_seconds"`
	// Event description (Markdown). Omitted when empty.
	Description string `json:"description" toon:"description"`
	// Whether this event is a retrospective (historical) one. Omitted when false.
	IsRetrospective bool `json:"is_retrospective" toon:"is_retrospective"`
	// Linked event IDs (related incidents, deployments, etc.). Omitted when empty.
	LinkedChangeIDs []string `json:"linked_change_ids" toon:"linked_change_ids"`
	// Whether subscribers were notified about this event. Omitted when false.
	NotifySubscribers bool `json:"notify_subscribers" toon:"notify_subscribers"`
	// Parent status page ID. Omitted when 0 (never for stored events).
	PageID int64 `json:"page_id" toon:"page_id"`
	// Member IDs responsible for this event. Omitted when no responders are assigned.
	ResponderIDs []int64 `json:"responder_ids" toon:"responder_ids"`
	// Event start time in Unix seconds, derived from the first timeline update. Omitted when 0.
	StartAtSeconds Timestamp `json:"start_at_seconds" toon:"start_at_seconds"`
	// Current event status. Incident statuses: `investigating`/`identified`/`monitoring`/`resolved`. Maintenance statuses: `scheduled`/`ongoing`/`completed`. Omitted when empty (never for stored events).
	Status string `json:"status" toon:"status"`
	// Event title.
	Title string `json:"title" toon:"title"`
	// Change type. `incident` is an unplanned outage; `maintenance` is a planned maintenance. The type determines which status values are valid.
	Type string `json:"type" toon:"type"`
	// Timeline updates attached to this event, ordered by time. Omitted when the event has no timeline updates.
	Updates []StatusPageChangeUpdateItem `json:"updates" toon:"updates"`
}

StatusPageChangeItem is generated from the Flashduty OpenAPI schema.

type StatusPageChangeListResponse 

type StatusPageChangeListResponse struct {
	// Status page changes (incidents/maintenances) matching the filters.
	Items []StatusPageChangeItem `json:"items" toon:"items"`
}

StatusPageChangeListResponse is generated from the Flashduty OpenAPI schema.

type StatusPageChangeTimelineCreateResponse 

type StatusPageChangeTimelineCreateResponse struct {
	// Newly created update ID.
	UpdateID string `json:"update_id" toon:"update_id"`
}

StatusPageChangeTimelineCreateResponse is generated from the Flashduty OpenAPI schema.

type StatusPageChangeUpdateItem 

type StatusPageChangeUpdateItem struct {
	// Update timestamp in Unix seconds.
	AtSeconds Timestamp `json:"at_seconds" toon:"at_seconds"`
	// Component status transitions applied by this update. Omitted when the update changes no component statuses.
	ComponentChanges []StatusPageComponentChangeItem `json:"component_changes" toon:"component_changes"`
	// Update description (Markdown). Omitted when empty.
	Description string `json:"description" toon:"description"`
	// Change status after this update. Omitted when the update does not change the overall status. The first four values apply to incident-type changes, the last three to maintenance-type changes.
	// | Value | Meaning |
	// |---|---|
	// | `investigating` | Investigating (incident). |
	// | `identified` | Root cause identified (incident). |
	// | `monitoring` | Fix deployed, monitoring (incident). |
	// | `resolved` | Resolved (incident). |
	// | `scheduled` | Scheduled (maintenance). |
	// | `ongoing` | In progress (maintenance). |
	// | `completed` | Completed (maintenance). |
	Status string `json:"status" toon:"status"`
	// Update ID.
	UpdateID string `json:"update_id" toon:"update_id"`
}

StatusPageChangeUpdateItem is generated from the Flashduty OpenAPI schema.

type StatusPageComponentChangeItem 

type StatusPageComponentChangeItem struct {
	// Component ID.
	ComponentID string `json:"component_id" toon:"component_id"`
	// Component display name. Populated by the backend on read; ignored on write. Omitted when empty.
	ComponentName string `json:"component_name" toon:"component_name"`
	// New component status. Incidents support `operational`/`degraded`/`partial_outage`/`full_outage`; maintenances support `operational`/`under_maintenance`.
	Status string `json:"status" toon:"status"`
}

StatusPageComponentChangeItem is generated from the Flashduty OpenAPI schema.

type StatusPageComponentItem 

type StatusPageComponentItem struct {
	// Time the component became available, as a Unix timestamp in seconds. Omitted when 0.
	AvailableSinceSeconds Timestamp `json:"available_since_seconds" toon:"available_since_seconds"`
	// Component ID. Omitted when empty.
	ComponentID string `json:"component_id" toon:"component_id"`
	// Component description. Omitted when empty.
	Description string `json:"description" toon:"description"`
	// When true, the component is hidden entirely from summary endpoints. Omitted when false.
	HideAll bool `json:"hide_all" toon:"hide_all"`
	// When true, uptime data is hidden from summary responses. Omitted when false.
	HideUptime bool `json:"hide_uptime" toon:"hide_uptime"`
	// Component display name.
	Name string `json:"name" toon:"name"`
	// Display order within its section. Omitted when 0.
	OrderID int64 `json:"order_id" toon:"order_id"`
	// Parent section ID. Omitted when the component sits at the top level.
	SectionID string `json:"section_id" toon:"section_id"`
}

StatusPageComponentItem is generated from the Flashduty OpenAPI schema.

type StatusPageDraftCreateResponse added in v0.14.5 

type StatusPageDraftCreateResponse struct {
	// Creation time in Unix epoch seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Draft ID matching `draft_[A-Za-z0-9]{22}`; the console review link carries it.
	DraftID string `json:"draft_id" toon:"draft_id"`
}

StatusPageDraftCreateResponse is generated from the Flashduty OpenAPI schema.

type StatusPageInfoResponse added in v0.14.3 

type StatusPageInfoResponse struct {
	// Components tracked on the status page.
	Components []StatusPageComponentItem `json:"components" toon:"components"`
	// Get-in-touch contact, a mailto or website URL. Omitted when not set.
	ContactInfo string `json:"contact_info" toon:"contact_info"`
	// Custom domain pointing to the status page. Omitted when not set.
	CustomDomain string `json:"custom_domain" toon:"custom_domain"`
	// Custom navigation links shown on the status page. Omitted when not set.
	CustomLinks []map[string]string `json:"custom_links" toon:"custom_links"`
	DarkLogo string `json:"dark_logo" toon:"dark_logo"`
	// How the timeline displays change dates. `calendar` uses a calendar view; `list` uses a list view. Omitted when not set.
	DateView string `json:"date_view" toon:"date_view"`
	// How uptime is displayed. `chart_and_percentage` shows both the uptime chart and the percentage figure; `chart` shows only the chart; `none` hides uptime entirely. Omitted when not set.
	DisplayUptimeMode string `json:"display_uptime_mode" toon:"display_uptime_mode"`
	// Favicon of the status page. Omitted when not set.
	Favicon string `json:"favicon" toon:"favicon"`
	Logo string `json:"logo" toon:"logo"`
	// URL opened when the logo is clicked. Omitted when not set.
	LogoURL string `json:"logo_url" toon:"logo_url"`
	// Whether the managed custom-domain feature is enabled for this page. `true` for public pages, always `false` for internal pages.
	ManagedDomainFeatureEnabled bool `json:"managed_domain_feature_enabled" toon:"managed_domain_feature_enabled"`
	// Display name of the status page.
	Name string `json:"name" toon:"name"`
	// Footer content of the status page. Omitted when not set.
	PageFooter string `json:"page_footer" toon:"page_footer"`
	// Header content of the status page. Omitted when not set.
	PageHeader string `json:"page_header" toon:"page_header"`
	// Status page ID.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Sections grouping the components.
	Sections []StatusPageSectionItem `json:"sections" toon:"sections"`
	// Subscription channel toggles.
	Subscription StatusPageSubscriptionItem `json:"subscription" toon:"subscription"`
	// Preferred event template type: `pre_defined` or `message`. Omitted when never set.
	TemplatePreference string `json:"template_preference" toon:"template_preference"`
	// Page visibility type. `public` pages are accessible to anyone and use email subscriptions; `internal` pages are restricted to account members and use IM subscriptions.
	Type string `json:"type" toon:"type"`
	// URL-safe slug, unique per account.
	URLName string `json:"url_name" toon:"url_name"`
}

StatusPageInfoResponse is generated from the Flashduty OpenAPI schema.

type StatusPageItem added in v0.4.0 

type StatusPageItem struct {
	// Components tracked on the status page.
	Components []StatusPageComponentItem `json:"components" toon:"components"`
	// Get-in-touch contact, a mailto or website URL. Omitted when not set.
	ContactInfo string `json:"contact_info" toon:"contact_info"`
	// Custom domain pointing to the status page. Omitted when not set.
	CustomDomain string `json:"custom_domain" toon:"custom_domain"`
	// Custom navigation links shown on the status page. Omitted when not set.
	CustomLinks []map[string]string `json:"custom_links" toon:"custom_links"`
	DarkLogo string `json:"dark_logo" toon:"dark_logo"`
	// How the timeline displays change dates. `calendar` uses a calendar view; `list` uses a list view. Omitted when not set.
	DateView string `json:"date_view" toon:"date_view"`
	// How uptime is displayed. `chart_and_percentage` shows both the uptime chart and the percentage figure; `chart` shows only the chart; `none` hides uptime entirely. Omitted when not set.
	DisplayUptimeMode string `json:"display_uptime_mode" toon:"display_uptime_mode"`
	// Favicon of the status page. Omitted when not set.
	Favicon string `json:"favicon" toon:"favicon"`
	Logo string `json:"logo" toon:"logo"`
	// URL opened when the logo is clicked. Omitted when not set.
	LogoURL string `json:"logo_url" toon:"logo_url"`
	// Display name of the status page.
	Name string `json:"name" toon:"name"`
	// Footer content of the status page. Omitted when not set.
	PageFooter string `json:"page_footer" toon:"page_footer"`
	// Header content of the status page. Omitted when not set.
	PageHeader string `json:"page_header" toon:"page_header"`
	// Status page ID.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Sections grouping the components.
	Sections []StatusPageSectionItem `json:"sections" toon:"sections"`
	// Subscription channel toggles.
	Subscription StatusPageSubscriptionItem `json:"subscription" toon:"subscription"`
	// Preferred event template type: `pre_defined` or `message`. Omitted when never set.
	TemplatePreference string `json:"template_preference" toon:"template_preference"`
	// Page visibility type. `public` pages are accessible to anyone and use email subscriptions; `internal` pages are restricted to account members and use IM subscriptions.
	Type string `json:"type" toon:"type"`
	// URL-safe slug, unique per account.
	URLName string `json:"url_name" toon:"url_name"`
}

StatusPageItem is generated from the Flashduty OpenAPI schema.

type StatusPageMessageTemplate added in v0.14.3 

type StatusPageMessageTemplate struct {
	// Notification text (Markdown) per event status. Keys are change statuses valid for the template's `type` (for example `investigating` or `resolved` for incidents); the value is the text used when the event reaches that status.
	Messages map[string]string `json:"messages,omitempty" toon:"messages,omitempty"`
	// Template ID. Omit to create a new template; supply to update an existing one.
	TemplateID string `json:"template_id,omitempty" toon:"template_id,omitempty"`
	// Template title.
	Title string `json:"title,omitempty" toon:"title,omitempty"`
	// Change type the template applies to: `incident` unplanned incident, `maintenance` planned maintenance.
	Type string `json:"type,omitempty" toon:"type,omitempty"`
}

StatusPageMessageTemplate is generated from the Flashduty OpenAPI schema.

type StatusPageMigrationJob 

type StatusPageMigrationJob struct {
	// Owner account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Job creation time as a Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Terminal error message when `status` is `failed`. Omitted when the job has not failed.
	Error string `json:"error" toon:"error"`
	// Migration job ID.
	JobID string `json:"job_id" toon:"job_id"`
	// Current migration phase. `structure` imports the page structure (sections and components); `history` imports historical incidents, maintenances, and incident templates; `subscribers` imports email subscribers.
	Phase string `json:"phase" toon:"phase"`
	// Per-entity progress counters.
	Progress StatusPageMigrationProgress `json:"progress" toon:"progress"`
	// Atlassian Statuspage source page ID.
	SourcePageID string `json:"source_page_id" toon:"source_page_id"`
	// Current job status.
	// | Value | Meaning |
	// |---|---|
	// | `running` | In progress. |
	// | `completed` | Finished successfully. |
	// | `failed` | Failed; the `error` field holds the reason. |
	// | `cancelled` | Canceled by request. |
	Status string `json:"status" toon:"status"`
	// Flashduty target status page ID. Set once the job produces one, or supplied up front for subscriber migration.
	TargetPageID int64 `json:"target_page_id" toon:"target_page_id"`
	// Last status update time as a Unix timestamp in seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

StatusPageMigrationJob is generated from the Flashduty OpenAPI schema.

type StatusPageMigrationProgress 

type StatusPageMigrationProgress struct {
	// Steps completed so far.
	CompletedSteps int64 `json:"completed_steps" toon:"completed_steps"`
	// Number of components imported from the source status page.
	ComponentsImported int64 `json:"components_imported" toon:"components_imported"`
	// Number of historical incidents imported.
	IncidentsImported int64 `json:"incidents_imported" toon:"incidents_imported"`
	// Number of scheduled maintenances imported.
	MaintenancesImported int64 `json:"maintenances_imported" toon:"maintenances_imported"`
	// Number of sections (Atlassian component groups) imported from the source status page.
	SectionsImported int64 `json:"sections_imported" toon:"sections_imported"`
	// Number of email subscribers successfully imported.
	SubscribersImported int64 `json:"subscribers_imported" toon:"subscribers_imported"`
	// Number of subscribers skipped (e.g. because they would create duplicates).
	SubscribersSkipped int64 `json:"subscribers_skipped" toon:"subscribers_skipped"`
	// Number of incident templates successfully imported; templates that fail are skipped and recorded in `warnings`.
	TemplatesImported int64 `json:"templates_imported" toon:"templates_imported"`
	// Total steps this job will perform.
	TotalSteps int64 `json:"total_steps" toon:"total_steps"`
	// Non-fatal warnings recorded during the job. Omitted when empty.
	Warnings []string `json:"warnings" toon:"warnings"`
}

StatusPageMigrationProgress is generated from the Flashduty OpenAPI schema.

type StatusPageMigrationStartResponse 

type StatusPageMigrationStartResponse struct {
	// Migration job ID. Use this to poll status or request cancellation.
	JobID string `json:"job_id" toon:"job_id"`
}

StatusPageMigrationStartResponse is generated from the Flashduty OpenAPI schema.

type StatusPagePreDefinedTemplate added in v0.14.3 

type StatusPagePreDefinedTemplate struct {
	// Template body text (Markdown).
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Change status the template maps to. Incidents use `investigating`/`identified`/`monitoring`/`resolved`; maintenances use `scheduled`/`ongoing`/`completed`.
	Status string `json:"status,omitempty" toon:"status,omitempty"`
	// Template ID. Omit to create a new template; supply to update an existing one.
	TemplateID string `json:"template_id,omitempty" toon:"template_id,omitempty"`
	// Template title.
	Title string `json:"title,omitempty" toon:"title,omitempty"`
	// Change type the template applies to: `incident` unplanned incident, `maintenance` planned maintenance.
	Type string `json:"type,omitempty" toon:"type,omitempty"`
}

StatusPagePreDefinedTemplate is generated from the Flashduty OpenAPI schema.

type StatusPageSectionItem added in v0.4.0 

type StatusPageSectionItem struct {
	// Section description.
	Description string `json:"description" toon:"description"`
	// Whether the section and its components are hidden from summary endpoints.
	HideAll bool `json:"hide_all" toon:"hide_all"`
	// Whether uptime data is hidden from summary responses.
	HideUptime bool `json:"hide_uptime" toon:"hide_uptime"`
	// Section name.
	Name string `json:"name" toon:"name"`
	// Display order of the section. Omitted when 0.
	OrderID int64 `json:"order_id" toon:"order_id"`
	// Section ID. Omitted when empty.
	SectionID string `json:"section_id" toon:"section_id"`
}

StatusPageSectionItem is generated from the Flashduty OpenAPI schema.

type StatusPageSubscriberExportResponse 

type StatusPageSubscriberExportResponse string

func (StatusPageSubscriberExportResponse) String added in v0.5.2 

func (e StatusPageSubscriberExportResponse) String() string

String returns the underlying string value, implementing fmt.Stringer.

type StatusPageSubscriberListResponse 

type StatusPageSubscriberListResponse struct {
	// Whether there is at least one more page after the current one.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Subscribers on the current page.
	Items []ExportedStatusPageSubscriberItem `json:"items" toon:"items"`
	// Total matching subscribers.
	Total int64 `json:"total" toon:"total"`
}

StatusPageSubscriberListResponse is generated from the Flashduty OpenAPI schema.

type StatusPageSubscriptionItem added in v0.4.0 

type StatusPageSubscriptionItem struct {
	// Whether email subscription is enabled.
	Email bool `json:"email" toon:"email"`
	// Whether IM subscription is enabled.
	Im bool `json:"im" toon:"im"`
}

StatusPageSubscriptionItem is generated from the Flashduty OpenAPI schema.

type StatusPagesChangeActiveListRequest added in v0.4.1 

type StatusPagesChangeActiveListRequest struct {
	// Status page ID.
	PageID int64 `url:"page_id"`
	// Event type filter. Required. Returns only in-progress (non-terminal) events — `investigating`/`identified`/`monitoring` for `incident`, `scheduled`/`ongoing` for `maintenance`.
	Type string `url:"type"`
}

StatusPagesChangeActiveListRequest holds the query parameters for List active status page events.

type StatusPagesChangeInfoRequest 

type StatusPagesChangeInfoRequest struct {
	// Status page ID.
	PageID int64 `url:"page_id"`
	// Event (change) ID.
	ChangeID int64 `url:"change_id"`
}

StatusPagesChangeInfoRequest holds the query parameters for Get status page event detail.

type StatusPagesChangeListRequest 

type StatusPagesChangeListRequest struct {
	// Status page ID.
	PageID int64 `url:"page_id"`
	// Lower bound of the event activity window: only events still open at, or closed at or after, this Unix timestamp (seconds) are returned.
	StartAtSeconds int64 `url:"start_at_seconds,omitempty"`
	// Upper bound of the event activity window: only events started at or before this Unix timestamp (seconds) are returned.
	EndAtSeconds int64 `url:"end_at_seconds,omitempty"`
	// Event type filter. Required.
	Type string `url:"type"`
	// Event status filter. Required. Must be a status valid for the given `type` (`investigating`/`identified`/`monitoring`/`resolved` for `incident`; `scheduled`/`ongoing`/`completed` for `maintenance`).
	Status string `url:"status"`
}

StatusPagesChangeListRequest holds the query parameters for List status page events.

type StatusPagesInfoRequest added in v0.5.4 

type StatusPagesInfoRequest struct {
	// Status page ID.
	PageID int64 `url:"page_id"`
}

StatusPagesInfoRequest holds the query parameters for Get status page detail.

type StatusPagesMigrationStatusRequest 

type StatusPagesMigrationStatusRequest struct {
	// Migration job ID returned by `migrate-structure` or `migrate-email-subscribers`.
	JobID string `url:"job_id"`
}

StatusPagesMigrationStatusRequest holds the query parameters for Get migration status.

type StatusPagesService 

type StatusPagesService service

StatusPagesService handles the "On-call/Status pages" API resource.

func (*StatusPagesService) ChangeActiveList added in v0.4.1 

func (s *StatusPagesService) ChangeActiveList(ctx context.Context, req *StatusPagesChangeActiveListRequest) (*StatusPageChangeListResponse, *Response, error)

List active status page events.

List in-progress (non-terminal) events of a given type for a status page.

API: GET /status-page/change/active/list (statusPageChangeActiveList).

func (*StatusPagesService) ChangeCreate 

func (s *StatusPagesService) ChangeCreate(ctx context.Context, req *CreateStatusPageChangeRequest) (*StatusPageChangeCreateResponse, *Response, error)

Create status page event.

Create a new incident or maintenance event on a status page.

API: POST /status-page/change/create (statusPageChangeCreate).

func (*StatusPagesService) ChangeDelete 

func (s *StatusPagesService) ChangeDelete(ctx context.Context, req *DeleteStatusPageChangeRequest) (*Response, error)

Delete status page event.

Delete a status page event.

API: POST /status-page/change/delete (statusPageChangeDelete).

func (*StatusPagesService) ChangeInfo 

func (s *StatusPagesService) ChangeInfo(ctx context.Context, req *StatusPagesChangeInfoRequest) (*StatusPageChangeItem, *Response, error)

Get status page event detail.

Retrieve details of a specific status page event (incident or maintenance).

API: GET /status-page/change/info (statusPageChangeInfo).

func (*StatusPagesService) ChangeList 

func (s *StatusPagesService) ChangeList(ctx context.Context, req *StatusPagesChangeListRequest) (*StatusPageChangeListResponse, *Response, error)

List status page events.

List status page events for console management. Unlike the public display endpoints, the response includes hidden components.

API: GET /status-page/change/list (statusPageChangeList).

func (*StatusPagesService) ChangeTimelineCreate 

func (s *StatusPagesService) ChangeTimelineCreate(ctx context.Context, req *CreateStatusPageChangeTimelineRequest) (*StatusPageChangeTimelineCreateResponse, *Response, error)

Create event timeline entry.

Add a timeline update to a status page event.

API: POST /status-page/change/timeline/create (statusPageChangeTimelineCreate).

func (*StatusPagesService) ChangeTimelineDelete 

func (s *StatusPagesService) ChangeTimelineDelete(ctx context.Context, req *DeleteStatusPageChangeTimelineRequest) (*Response, error)

Delete event timeline entry.

Delete a timeline entry from a status page event.

API: POST /status-page/change/timeline/delete (statusPageChangeTimelineDelete).

func (*StatusPagesService) ChangeTimelineUpdate 

func (s *StatusPagesService) ChangeTimelineUpdate(ctx context.Context, req *UpdateStatusPageChangeTimelineRequest) (*Response, error)

Update event timeline entry.

Update a timeline entry for a status page event.

API: POST /status-page/change/timeline/update (statusPageChangeTimelineUpdate).

func (*StatusPagesService) ChangeUpdate 

func (s *StatusPagesService) ChangeUpdate(ctx context.Context, req *UpdateStatusPageChangeRequest) (*Response, error)

Update status page event.

Update an existing status page event.

API: POST /status-page/change/update (statusPageChangeUpdate).

func (*StatusPagesService) ComponentDelete added in v0.5.4 

func (s *StatusPagesService) ComponentDelete(ctx context.Context, req *DeleteStatusPageComponentRequest) (*Response, error)

Delete status page component.

Delete a service component from a status page.

API: POST /status-page/component/delete (statusPageComponentDelete).

func (*StatusPagesService) ComponentUpsert added in v0.5.4 

func (s *StatusPagesService) ComponentUpsert(ctx context.Context, req *UpsertStatusPageComponentRequest) (*UpsertStatusPageComponentResponse, *Response, error)

Upsert status page component.

Create or update a service component on a status page.

API: POST /status-page/component/upsert (statusPageComponentUpsert).

func (*StatusPagesService) Create added in v0.5.4 

func (s *StatusPagesService) Create(ctx context.Context, req *CreateStatusPageRequest) (*CreateStatusPageResponse, *Response, error)

Create status page.

Create a new status page.

API: POST /status-page/create (statusPageCreate).

func (*StatusPagesService) Delete added in v0.5.4 

func (s *StatusPagesService) Delete(ctx context.Context, req *DeleteStatusPageRequest) (*Response, error)

Delete status page.

Delete a status page.

API: POST /status-page/delete (statusPageDelete).

func (*StatusPagesService) DraftCreate added in v0.14.5 

func (s *StatusPagesService) DraftCreate(ctx context.Context, req *CreateStatusPageDraftRequest) (*StatusPageDraftCreateResponse, *Response, error)

Create status page draft.

Store a status page event draft so a human can review and publish it from the console.

API: POST /status-page/draft/create (statusPageDraftCreate).

func (*StatusPagesService) Info added in v0.5.4 

func (s *StatusPagesService) Info(ctx context.Context, req *StatusPagesInfoRequest) (*StatusPageInfoResponse, *Response, error)

Get status page detail.

Retrieve detailed configuration for a specific status page.

API: GET /status-page/info (statusPageInfo).

func (*StatusPagesService) MigrateEmailSubscribers 

func (s *StatusPagesService) MigrateEmailSubscribers(ctx context.Context, req *MigrateStatusPageEmailSubscribersRequest) (*StatusPageMigrationStartResponse, *Response, error)

Migrate email subscribers.

Start a migration job that imports email subscribers from an Atlassian Statuspage into an existing Flashduty status page.

API: POST /status-page/migrate-email-subscribers (statusPageMigrateEmailSubscribers).

func (*StatusPagesService) MigrateStructure 

func (s *StatusPagesService) MigrateStructure(ctx context.Context, req *MigrateStatusPageStructureRequest) (*StatusPageMigrationStartResponse, *Response, error)

Migrate status page structure.

Start a migration job that imports the structure and historical events of an Atlassian Statuspage into a new Flashduty status page.

API: POST /status-page/migrate-structure (statusPageMigrateStructure).

func (*StatusPagesService) MigrationCancel 

func (s *StatusPagesService) MigrationCancel(ctx context.Context, req *CancelStatusPageMigrationRequest) (*Response, error)

Cancel status page migration.

Cancel an in-progress status page migration job. Only jobs currently in the `running` state can be cancelled.

API: POST /status-page/migration/cancel (statusPageMigrationCancel).

func (*StatusPagesService) MigrationStatus 

func (s *StatusPagesService) MigrationStatus(ctx context.Context, req *StatusPagesMigrationStatusRequest) (*StatusPageMigrationJob, *Response, error)

Get migration status.

Get the current status and progress of a status page migration job.

API: GET /status-page/migration/status (statusPageMigrationStatus).

func (*StatusPagesService) ReadPageList added in v0.4.0 

func (s *StatusPagesService) ReadPageList(ctx context.Context) (*ListStatusPageResponse, *Response, error)

List status pages.

List all status pages owned by the account, including their components and sections.

API: GET /status-page/list (status-page-read-page-list).

func (*StatusPagesService) SectionDelete added in v0.5.4 

func (s *StatusPagesService) SectionDelete(ctx context.Context, req *DeleteStatusPageSectionRequest) (*Response, error)

Delete status page section.

Delete a section from a status page.

API: POST /status-page/section/delete (statusPageSectionDelete).

func (*StatusPagesService) SectionUpsert added in v0.5.4 

func (s *StatusPagesService) SectionUpsert(ctx context.Context, req *UpsertStatusPageSectionRequest) (*UpsertStatusPageSectionResponse, *Response, error)

Upsert status page section.

Create or update a section on a status page.

API: POST /status-page/section/upsert (statusPageSectionUpsert).

func (*StatusPagesService) SubscriberExport 

func (s *StatusPagesService) SubscriberExport(ctx context.Context, req *ExportStatusPageSubscribersRequest) (*Response, error)

Export subscribers.

Export subscribers list for a status page as a CSV attachment. The response is a `text/csv` file with columns: Method, Recipient, Components, Subscribe All, Locale.

The success body is a file, not a JSON envelope: it is returned on Response.Raw.

API: POST /status-page/subscriber/export (statusPageSubscriberExport).

func (*StatusPagesService) SubscriberImport 

func (s *StatusPagesService) SubscriberImport(ctx context.Context, req *ImportStatusPageSubscribersRequest) (*Response, error)

Import subscribers.

Bulk import subscribers for a status page. The account must be allowlisted for subscriber import; otherwise the call is rejected with an access-denied error.

API: POST /status-page/subscriber/import (statusPageSubscriberImport).

func (*StatusPagesService) SubscriberList 

func (s *StatusPagesService) SubscriberList(ctx context.Context, req *StatusPagesSubscriberListRequest) (*StatusPageSubscriberListResponse, *Response, error)

List status page subscribers.

List subscribers who have signed up for status page notifications.

API: GET /status-page/subscriber/list (statusPageSubscriberList).

func (*StatusPagesService) TemplateDelete added in v0.5.4 

func (s *StatusPagesService) TemplateDelete(ctx context.Context, req *DeleteStatusPageTemplateRequest) (*Response, error)

Delete status page template.

Delete an event template from a status page.

API: POST /status-page/template/delete (statusPageTemplateDelete).

func (*StatusPagesService) TemplateList added in v0.5.4 

func (s *StatusPagesService) TemplateList(ctx context.Context, req *StatusPagesTemplateListRequest) (*ListStatusPageTemplatesResponse, *Response, error)

List status page templates.

List all event templates for a status page.

API: GET /status-page/template/list (statusPageTemplateList).

func (*StatusPagesService) TemplateUpsert added in v0.5.4 

func (s *StatusPagesService) TemplateUpsert(ctx context.Context, req *UpsertStatusPageTemplateRequest) (*UpsertStatusPageTemplateResponse, *Response, error)

Upsert status page template.

Create or update an event template for a status page.

API: POST /status-page/template/upsert (statusPageTemplateUpsert).

func (*StatusPagesService) Update added in v0.5.4 

func (s *StatusPagesService) Update(ctx context.Context, req *UpdateStatusPageRequest) (*Response, error)

Update status page.

Update an existing status page configuration.

API: POST /status-page/update (statusPageUpdate).

type StatusPagesSubscriberListRequest 

type StatusPagesSubscriberListRequest struct {
	// Status page ID.
	PageID int64 `url:"page_id"`
	// Comma-separated component IDs to filter subscribers by.
	ComponentIDs string `url:"component_ids,omitempty"`
	// Page number (1-based).
	P int64 `url:"p,omitempty"`
	// Page size (1-100).
	Limit int64 `url:"limit,omitempty"`
}

StatusPagesSubscriberListRequest holds the query parameters for List status page subscribers.

type StatusPagesTemplateListRequest added in v0.5.4 

type StatusPagesTemplateListRequest struct {
	// Status page ID.
	PageID int64 `url:"page_id"`
	// Template category. `pre_defined` returns predefined event templates; `message` returns message notification templates.
	Type string `url:"type"`
}

StatusPagesTemplateListRequest holds the query parameters for List status page templates.

type StoreRulesetItem 

type StoreRulesetItem struct {
	// Creation timestamp, Unix epoch seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Account ID of the creator.
	CreatorAccountID uint64 `json:"creator_account_id" toon:"creator_account_id"`
	// Member ID of the creator.
	CreatorID uint64 `json:"creator_id" toon:"creator_id"`
	// Display name of the creator.
	CreatorName string `json:"creator_name" toon:"creator_name"`
	// Ruleset ID.
	ID uint64 `json:"id" toon:"id"`
	// Description or title of the ruleset.
	Note string `json:"note" toon:"note"`
	// Sharing scope. `0` = private (visible to the creator and the account owner), `1` = account-shared, `2` = public.
	OpenFlag int64 `json:"open_flag" toon:"open_flag"`
	// JSON string containing the alert rule definitions. Omitted in list responses.
	Payload string `json:"payload" toon:"payload"`
	// Datasource type identifier this ruleset applies to.
	TypeIdent string `json:"type_ident" toon:"type_ident"`
	// Last update timestamp, Unix epoch seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

StoreRulesetItem is generated from the Flashduty OpenAPI schema.

type StoreRulesetListRequest 

type StoreRulesetListRequest struct {
	// Datasource type identifier to filter by, e.g. `prometheus`.
	TypeIdent string `json:"type_ident" toon:"type_ident"`
}

StoreRulesetListRequest is generated from the Flashduty OpenAPI schema.

type StoreRulesetListResponse 

type StoreRulesetListResponse []StoreRulesetItem

StoreRulesetListResponse is a list response payload.

type StoreRulesetUpdateRequest 

type StoreRulesetUpdateRequest struct {
	// Ruleset ID to update.
	ID uint64 `json:"id" toon:"id"`
	// New description.
	Note string `json:"note" toon:"note"`
	// New sharing scope. `0` = private (visible to the creator and the account owner), `1` = account-shared, `2` = public.
	OpenFlag int64 `json:"open_flag,omitempty" toon:"open_flag,omitempty"`
	// New JSON string of alert rule definitions.
	Payload string `json:"payload" toon:"payload"`
}

StoreRulesetUpdateRequest is generated from the Flashduty OpenAPI schema.

type StoreRulesetUpsertRequest 

type StoreRulesetUpsertRequest struct {
	// Description or title of the ruleset.
	Note string `json:"note" toon:"note"`
	// Sharing scope. `0` = private (visible to the creator and the account owner), `1` = account-shared, `2` = public. Defaults to `0` if omitted.
	OpenFlag int64 `json:"open_flag,omitempty" toon:"open_flag,omitempty"`
	// JSON string containing the alert rule definitions.
	Payload string `json:"payload" toon:"payload"`
	// Datasource type identifier this ruleset applies to, e.g. `prometheus`.
	TypeIdent string `json:"type_ident" toon:"type_ident"`
}

StoreRulesetUpsertRequest is generated from the Flashduty OpenAPI schema.

type StringMapPatch added in v0.14.3 

type StringMapPatch struct {
	// Keys to remove.
	Delete []string `json:"delete,omitempty" toon:"delete,omitempty"`
	// Keys to insert or replace.
	Set map[string]string `json:"set,omitempty" toon:"set,omitempty"`
}

StringMapPatch is generated from the Flashduty OpenAPI schema.

type TargetInventoryServiceMapCapability added in v0.14.3 

type TargetInventoryServiceMapCapability struct {
	// True if the current status derives from an authoritative graph snapshot.
	Authoritative bool `json:"authoritative" toon:"authoritative"`
	// Agent-reported capability status, e.g. `running`, `disabled`, `starting`, `failed`, `unsupported`. Omitted when the agent has not reported one.
	CapabilityStatus string `json:"capability_status" toon:"capability_status"`
	// Capture mode, e.g. `ebpf` or `polling`. Omitted when unknown.
	CaptureMode string `json:"capture_mode" toon:"capture_mode"`
	// Number of edges in the host's current graph.
	EdgeCount int64 `json:"edge_count" toon:"edge_count"`
	// Whether ServiceMap collection is enabled on the agent.
	Enabled bool `json:"enabled" toon:"enabled"`
	// Set to `status_unavailable` when the live status could not be read; other fields then fall back to inventory-derived values. Omitted otherwise.
	ErrorCode string `json:"error_code" toon:"error_code"`
	// Freshness classification of the host's graph. `fresh` = the latest snapshot was received within 2x the report interval; `stale` = no new snapshot within that window; `unknown` = not yet classified. Omitted when unknown.
	FreshnessStatus string `json:"freshness_status" toon:"freshness_status"`
	// True if a current graph can be fetched for this host right now.
	GraphAvailable bool `json:"graph_available" toon:"graph_available"`
	// Maximum snapshot age in milliseconds tolerated before it counts as stale. Omitted when not applicable.
	MaxAgeMs int64 `json:"max_age_ms" toon:"max_age_ms"`
	// Number of nodes in the host's current graph.
	NodeCount int64 `json:"node_count" toon:"node_count"`
	// Unix timestamp in milliseconds when the agent last observed graph generation. Omitted when unknown.
	ObservedAtMs TimestampMilli `json:"observed_at_ms" toon:"observed_at_ms"`
	// Machine-readable codes explaining the current capability status. Omitted when empty.
	ReasonCodes []string `json:"reason_codes" toon:"reason_codes"`
	// Unix timestamp in milliseconds when the server last received a snapshot. Omitted when unknown.
	ReceivedAtMs TimestampMilli `json:"received_at_ms" toon:"received_at_ms"`
	// Configured reporting interval in milliseconds. Omitted when unknown.
	ReportIntervalMs int64 `json:"report_interval_ms" toon:"report_interval_ms"`
	// True if the agent has produced at least one full snapshot.
	SnapshotReady bool `json:"snapshot_ready" toon:"snapshot_ready"`
	// ServiceMap collection status of the host.
	//
	// | Value | Meaning |
	// |---|---|
	// | `active` | Collection healthy: a fresh snapshot exists with no degradation. |
	// | `degraded` | Collecting but quality is impaired: health reports are newer than the snapshot, the snapshot is truncated/degraded, or collection is failing. |
	// | `stale` | A snapshot exists but is outdated (no update within 2x the report interval). |
	// | `initializing` | The agent reported the capability but the first snapshot is not ready yet. |
	// | `disabled` | Topology collection is disabled on this host. |
	// | `unsupported` | The agent or kernel does not support collection. |
	// | `no_data` | No snapshot or health data received yet. |
	Status string `json:"status" toon:"status"`
}

TargetInventoryServiceMapCapability is generated from the Flashduty OpenAPI schema.

type TargetInventoryServiceMapCoverage added in v0.14.3 

type TargetInventoryServiceMapCoverage struct {
	// Items whose live ServiceMap status read failed (`servicemap.error_code` set).
	Failed int64 `json:"failed" toon:"failed"`
	// True when at least one item's status read failed.
	Partial bool `json:"partial" toon:"partial"`
	// Items on this page that carry ServiceMap data.
	Requested int64 `json:"requested" toon:"requested"`
	// Items whose live ServiceMap status was read successfully.
	Succeeded int64 `json:"succeeded" toon:"succeeded"`
}

TargetInventoryServiceMapCoverage is generated from the Flashduty OpenAPI schema.

type TargetsListRequest 

type TargetsListRequest struct {
	// Optional consistency check. Must equal the authenticated account when supplied.
	AccountID int64 `json:"account_id,omitempty" toon:"account_id,omitempty"`
	// Opaque pagination cursor from the previous response's `next_cursor`. Omit / pass empty string for the first page. Reset whenever `keyword`, `limit`, or tenant changes.
	Cursor string `json:"cursor,omitempty" toon:"cursor,omitempty"`
	// Prefix match against `target_locator`. ASCII only, no whitespace, no `|`, max 256 bytes. Substring search is not supported.
	Keyword string `json:"keyword,omitempty" toon:"keyword,omitempty"`
	// Page size. Default 50, max 200.
	Limit int64 `json:"limit,omitempty" toon:"limit,omitempty"`
}

TargetsListRequest is generated from the Flashduty OpenAPI schema.

type TargetsListResponse 

type TargetsListResponse struct {
	// The current page of invocable targets, sorted ascending by `target_locator`.
	Items []TargetsListResponseItemsItem `json:"items" toon:"items"`
	// Opaque cursor for the next page. Absent / empty means this is the last page.
	NextCursor *string `json:"next_cursor,omitempty" toon:"next_cursor,omitempty"`
	// ServiceMap status-fetch coverage for this page. Omitted when no item on the page carries ServiceMap data.
	ServicemapCoverage TargetInventoryServiceMapCoverage `json:"servicemap_coverage" toon:"servicemap_coverage"`
	// Total matches for the current `(account_id, keyword)` pair, independent of `cursor`.
	Total int64 `json:"total" toon:"total"`
}

TargetsListResponse is generated from the Flashduty OpenAPI schema.

type TargetsListResponseItemsItem 

type TargetsListResponseItemsItem struct {
	// Most recently observed Agent version.
	AgentVersion string `json:"agent_version" toon:"agent_version"`
	// Edge cluster name.
	ClusterName string `json:"cluster_name" toon:"cluster_name"`
	// Edge instance address (`ip:port`), surfaced for diagnostics.
	EdgeIpport string `json:"edge_ipport" toon:"edge_ipport"`
	// ID of the host agent reporting this target. Omitted when the target is not associated with a host.
	HostID string `json:"host_id" toon:"host_id"`
	// ServiceMap capability and latest status of the target's host. Omitted when the reporting agent has no ServiceMap capability.
	Servicemap TargetInventoryServiceMapCapability `json:"servicemap" toon:"servicemap"`
	// Host target kind. Filtering by kind is not supported in v1.
	TargetKind string `json:"target_kind" toon:"target_kind"`
	// Target identifier; the list is sorted by this field ascending.
	TargetLocator string `json:"target_locator" toon:"target_locator"`
	// Last route-projection upsert time, Unix seconds. Treat as 'most recently observed', not a live-online indicator.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
}

TargetsListResponseItemsItem is generated from the Flashduty OpenAPI schema.

type TeamBriefItem 

type TeamBriefItem struct {
	// Array of person IDs belonging to the team; empty array (never null) when the team has no members.
	PersonIDs []uint64 `json:"person_ids" toon:"person_ids"`
	// Team ID.
	TeamID uint64 `json:"team_id" toon:"team_id"`
	// Team name.
	TeamName string `json:"team_name" toon:"team_name"`
}

TeamBriefItem is generated from the Flashduty OpenAPI schema.

type TeamDeleteRequest 

type TeamDeleteRequest struct {
	// External reference ID. Only used when neither `team_id` nor `team_name` is provided.
	RefID string `json:"ref_id,omitempty" toon:"ref_id,omitempty"`
	// Team ID. At least one of the three lookup fields is required; when several are provided, `team_id` wins.
	TeamID uint64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Team name. Only used when `team_id` is not provided.
	TeamName string `json:"team_name,omitempty" toon:"team_name,omitempty"`
}

TeamDeleteRequest is generated from the Flashduty OpenAPI schema.

type TeamInfoRequest 

type TeamInfoRequest struct {
	// External reference ID. When provided, takes precedence over `team_name` and `team_id`.
	RefID string `json:"ref_id,omitempty" toon:"ref_id,omitempty"`
	// Team ID. At least one of the three lookup fields is required; lowest priority — only used when neither `ref_id` nor `team_name` is provided.
	TeamID uint64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Team name. Only used when `ref_id` is not provided; takes precedence over `team_id`.
	TeamName string `json:"team_name,omitempty" toon:"team_name,omitempty"`
}

TeamInfoRequest is generated from the Flashduty OpenAPI schema.

type TeamInfosRequest 

type TeamInfosRequest struct {
	// List of team IDs to look up.
	TeamIDs []uint64 `json:"team_ids" toon:"team_ids"`
}

TeamInfosRequest is generated from the Flashduty OpenAPI schema.

type TeamInfosResponse 

type TeamInfosResponse struct {
	// Array of brief team info for the matched `team_ids`; may be null when no ID matches.
	Items []TeamBriefItem `json:"items" toon:"items"`
}

TeamInfosResponse is generated from the Flashduty OpenAPI schema.

type TeamItem 

type TeamItem struct {
	// Owning account ID.
	AccountID uint64 `json:"account_id" toon:"account_id"`
	// Unix epoch seconds the team was created.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Member ID of the creator.
	CreatorID uint64 `json:"creator_id" toon:"creator_id"`
	// Display name of the creator. Not populated by current endpoints — always an empty string; resolve `creator_id` via `POST /person/infos`.
	CreatorName string `json:"creator_name" toon:"creator_name"`
	// Free-form description.
	Description string `json:"description" toon:"description"`
	// Member IDs of team members.
	PersonIDs []uint64 `json:"person_ids" toon:"person_ids"`
	// External reference ID for third-party HR system integration.
	RefID string `json:"ref_id" toon:"ref_id"`
	// Team status. `enabled` — active; `deleted` — soft-deleted (only possible when fetching a deleted team by `team_id`; list and name/ref_id lookups exclude deleted teams).
	Status string `json:"status" toon:"status"`
	// Unique team ID.
	TeamID uint64 `json:"team_id" toon:"team_id"`
	// Team display name. 1–39 characters, unique per account.
	TeamName string `json:"team_name" toon:"team_name"`
	// Unix epoch seconds the team was last updated.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Member ID of the last editor.
	UpdatedBy uint64 `json:"updated_by" toon:"updated_by"`
	// Display name of the last editor.
	UpdatedByName string `json:"updated_by_name" toon:"updated_by_name"`
}

TeamItem is generated from the Flashduty OpenAPI schema.

type TeamListRequest 

type TeamListRequest struct {
	ListOptions
	// Ascending sort order. Default: false (descending).
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Sort field. Default: `updated_at`.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Filter by member ID — return only teams this person belongs to.
	PersonID uint64 `json:"person_id,omitempty" toon:"person_id,omitempty"`
	// Substring match on team name or description.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
}

TeamListRequest is generated from the Flashduty OpenAPI schema.

type TeamListResponse 

type TeamListResponse struct {
	ListOptions
	// Array of teams for the current page, used with `p`, `limit` and `total` for pagination; empty array on an empty page.
	Items []TeamItem `json:"items" toon:"items"`
	// Total number of teams matching the filter.
	Total int64 `json:"total" toon:"total"`
}

TeamListResponse is generated from the Flashduty OpenAPI schema.

type TeamUpsertRequest 

type TeamUpsertRequest struct {
	// Default country code applied to any `phones` entries that are not in E.164 format.
	CountryCode string `json:"countryCode,omitempty" toon:"countryCode,omitempty"`
	// Free-form description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Add existing members to the team by email. Addresses that don't match an existing member are silently ignored — no invitation is sent.
	Emails []string `json:"emails,omitempty" toon:"emails,omitempty"`
	// Member IDs to set as team members. Replaces the existing member list.
	PersonIDs []uint64 `json:"person_ids,omitempty" toon:"person_ids,omitempty"`
	// Add existing members to the team by phone number. Numbers not in E.164 format are parsed with `countryCode`; an unparseable number fails the whole request with a 400. Numbers that parse but match no existing member are silently ignored.
	Phones []string `json:"phones,omitempty" toon:"phones,omitempty"`
	// External reference ID for HR system integration.
	RefID string `json:"ref_id,omitempty" toon:"ref_id,omitempty"`
	// When true and `team_id` is 0, an existing team with the same `team_name` is updated in place instead of returning a name-conflict error.
	ResetIfNameExist bool `json:"reset_if_name_exist,omitempty" toon:"reset_if_name_exist,omitempty"`
	// Team ID. Omit or set to 0 to create a new team.
	TeamID uint64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Team display name. 1–39 characters.
	TeamName string `json:"team_name" toon:"team_name"`
}

TeamUpsertRequest is generated from the Flashduty OpenAPI schema.

type TeamUpsertResponse 

type TeamUpsertResponse struct {
	// Created or updated team ID.
	TeamID uint64 `json:"team_id" toon:"team_id"`
	// Team name echoed from the request.
	TeamName string `json:"team_name" toon:"team_name"`
}

TeamUpsertResponse is generated from the Flashduty OpenAPI schema.

type TeamsService 

type TeamsService service

TeamsService handles the "Platform/Teams" API resource.

func (*TeamsService) ReadInfo 

func (s *TeamsService) ReadInfo(ctx context.Context, req *TeamInfoRequest) (*TeamItem, *Response, error)

Get team detail.

Return a single team by ID, name, or external reference ID.

API: POST /team/info (team-read-info).

func (*TeamsService) ReadInfos 

func (s *TeamsService) ReadInfos(ctx context.Context, req *TeamInfosRequest) (*TeamInfosResponse, *Response, error)

Batch get teams.

Return basic info for multiple teams by their IDs in a single request.

API: POST /team/infos (team-read-infos).

func (*TeamsService) ReadList 

func (s *TeamsService) ReadList(ctx context.Context, req *TeamListRequest) (*TeamListResponse, *Response, error)

List teams.

Return a paginated list of teams in the current account.

API: POST /team/list (team-read-list).

func (*TeamsService) WriteDelete 

func (s *TeamsService) WriteDelete(ctx context.Context, req *TeamDeleteRequest) (*Response, error)

Delete a team.

Permanently delete a team by ID, name, or external reference ID.

API: POST /team/delete (team-write-delete).

func (*TeamsService) WriteUpsert 

func (s *TeamsService) WriteUpsert(ctx context.Context, req *TeamUpsertRequest) (*TeamUpsertResponse, *Response, error)

Create or update a team.

Create a new team or update an existing one. Pass `team_id` to update.

API: POST /team/upsert (team-write-upsert).

type TemplateCreateRequest 

type TemplateCreateRequest struct {
	// Free-form description. Up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// DingTalk robot message template source.
	Dingtalk string `json:"dingtalk,omitempty" toon:"dingtalk,omitempty"`
	// DingTalk app message template source.
	DingtalkApp string `json:"dingtalk_app,omitempty" toon:"dingtalk_app,omitempty"`
	// Email body template source (Go `html/template` syntax).
	Email string `json:"email,omitempty" toon:"email,omitempty"`
	// Feishu robot message template source.
	Feishu string `json:"feishu,omitempty" toon:"feishu,omitempty"`
	// Feishu app message template source.
	FeishuApp string `json:"feishu_app,omitempty" toon:"feishu_app,omitempty"`
	// Render alert labels as a table in Feishu app cards.
	FeishuAppCardV2TableEnabled bool `json:"feishu_app_card_v2_table_enabled,omitempty" toon:"feishu_app_card_v2_table_enabled,omitempty"`
	// Incident card fields hidden per IM app type.
	IncidentCardHiddenFields IncidentCardHiddenFields `json:"incident_card_hidden_fields,omitempty" toon:"incident_card_hidden_fields,omitempty"`
	// Slack robot message template source.
	Slack string `json:"slack,omitempty" toon:"slack,omitempty"`
	// Slack app message template source.
	SlackApp string `json:"slack_app,omitempty" toon:"slack_app,omitempty"`
	// SMS template source (Go `text/template` syntax).
	SMS string `json:"sms,omitempty" toon:"sms,omitempty"`
	// Team scope. 0 for account-wide.
	TeamID int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Microsoft Teams app message template source.
	TeamsApp string `json:"teams_app,omitempty" toon:"teams_app,omitempty"`
	// Telegram bot message template source.
	Telegram string `json:"telegram,omitempty" toon:"telegram,omitempty"`
	// Template name, unique per account. 1–39 characters.
	TemplateName string `json:"template_name" toon:"template_name"`
	// Voice call script template source.
	Voice string `json:"voice,omitempty" toon:"voice,omitempty"`
	// WeCom robot message template source.
	Wecom string `json:"wecom,omitempty" toon:"wecom,omitempty"`
	// WeCom app message template source.
	WecomApp string `json:"wecom_app,omitempty" toon:"wecom_app,omitempty"`
	// Zoom bot message template source.
	Zoom string `json:"zoom,omitempty" toon:"zoom,omitempty"`
}

TemplateCreateRequest is generated from the Flashduty OpenAPI schema.

type TemplateCreateResponse 

type TemplateCreateResponse struct {
	// Newly created template ID.
	TemplateID string `json:"template_id" toon:"template_id"`
	// Template name echoed from the request.
	TemplateName string `json:"template_name" toon:"template_name"`
}

TemplateCreateResponse is generated from the Flashduty OpenAPI schema.

type TemplateIDRequest 

type TemplateIDRequest struct {
	// Target template ID. Pass `6321aad26c12104586a88916` to address the built-in preset.
	TemplateID string `json:"template_id" toon:"template_id"`
}

TemplateIDRequest is generated from the Flashduty OpenAPI schema.

type TemplateItem 

type TemplateItem struct {
	// ID of the owning account.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Unix epoch seconds the template was created.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Member ID of the creator.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Unix epoch seconds the template was soft-deleted. Absent (omitempty) when the template is live.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Free-form description.
	Description string `json:"description" toon:"description"`
	// DingTalk robot message template source.
	Dingtalk string `json:"dingtalk" toon:"dingtalk"`
	// DingTalk app message template source.
	DingtalkApp string `json:"dingtalk_app" toon:"dingtalk_app"`
	// Email body template source (Go `html/template` syntax).
	Email string `json:"email" toon:"email"`
	// Feishu robot message template source.
	Feishu string `json:"feishu" toon:"feishu"`
	// Feishu app message template source.
	FeishuApp string `json:"feishu_app" toon:"feishu_app"`
	// Whether alert labels use table rendering in Feishu app cards.
	FeishuAppCardV2TableEnabled bool `json:"feishu_app_card_v2_table_enabled" toon:"feishu_app_card_v2_table_enabled"`
	// Incident card fields hidden per IM app type; an empty object when none are configured.
	IncidentCardHiddenFields IncidentCardHiddenFields `json:"incident_card_hidden_fields" toon:"incident_card_hidden_fields"`
	// Slack robot message template source.
	Slack string `json:"slack" toon:"slack"`
	// Slack app message template source.
	SlackApp string `json:"slack_app" toon:"slack_app"`
	// SMS template source (Go `text/template` syntax).
	SMS string `json:"sms" toon:"sms"`
	// Template lifecycle status. `enabled` templates can be referenced by escalation policies for notifications; `disabled` templates are no longer used for new notifications; `deleted` templates are never returned by list endpoints.
	Status string `json:"status" toon:"status"`
	// ID of the team this template is scoped to, or 0 for account-wide.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Microsoft Teams app message template source.
	TeamsApp string `json:"teams_app" toon:"teams_app"`
	// Telegram bot message template source.
	Telegram string `json:"telegram" toon:"telegram"`
	// Template ID.
	TemplateID string `json:"template_id" toon:"template_id"`
	// Unique template name within the account.
	TemplateName string `json:"template_name" toon:"template_name"`
	// Unix epoch seconds the template was last updated.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Member ID of the last editor.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
	// Voice call script template source.
	Voice string `json:"voice" toon:"voice"`
	// WeCom robot message template source.
	Wecom string `json:"wecom" toon:"wecom"`
	// WeCom app message template source.
	WecomApp string `json:"wecom_app" toon:"wecom_app"`
	// Zoom bot message template source.
	Zoom string `json:"zoom" toon:"zoom"`
}

TemplateItem is generated from the Flashduty OpenAPI schema.

type TemplateListRequest 

type TemplateListRequest struct {
	ListOptions
	// Ascending sort order.
	Asc bool `json:"asc,omitempty" toon:"asc,omitempty"`
	// Filter by creator member ID; obtain member IDs from `POST /member/list`.
	CreatorID *int64 `json:"creator_id,omitempty" toon:"creator_id,omitempty"`
	// When true, only return templates scoped to teams the caller belongs to.
	IsMyTeam bool `json:"is_my_team,omitempty" toon:"is_my_team,omitempty"`
	// Sort field.
	Orderby string `json:"orderby,omitempty" toon:"orderby,omitempty"`
	// Regex or substring match on template_name.
	Query string `json:"query,omitempty" toon:"query,omitempty"`
	// Filter by specific team IDs.
	TeamIDs []int64 `json:"team_ids,omitempty" toon:"team_ids,omitempty"`
}

TemplateListRequest is generated from the Flashduty OpenAPI schema.

type TemplateListResponse 

type TemplateListResponse struct {
	// True if another page exists after the returned one.
	HasNextPage bool `json:"has_next_page" toon:"has_next_page"`
	// Notification templates on the current page; the first item of the first page is always the built-in preset template.
	Items []TemplateItem `json:"items" toon:"items"`
	// Total number of templates matching the filter, across all pages (including the built-in preset template).
	Total int64 `json:"total" toon:"total"`
}

TemplateListResponse is generated from the Flashduty OpenAPI schema.

type TemplateUpdateRequest 

type TemplateUpdateRequest struct {
	// Free-form description. Up to 500 characters. Omit to keep the current content; send an empty string to clear it.
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// DingTalk robot message template source. Omit to keep the current content; send an empty string to clear it.
	Dingtalk *string `json:"dingtalk,omitempty" toon:"dingtalk,omitempty"`
	// DingTalk app message template source. Omit to keep the current content; send an empty string to clear it.
	DingtalkApp *string `json:"dingtalk_app,omitempty" toon:"dingtalk_app,omitempty"`
	// Email body template source (Go `html/template` syntax). Omit to keep the current content; send an empty string to clear it.
	Email *string `json:"email,omitempty" toon:"email,omitempty"`
	// Feishu robot message template source. Omit to keep the current content; send an empty string to clear it.
	Feishu *string `json:"feishu,omitempty" toon:"feishu,omitempty"`
	// Feishu app message template source. Omit to keep the current content; send an empty string to clear it.
	FeishuApp *string `json:"feishu_app,omitempty" toon:"feishu_app,omitempty"`
	// When set, enable or disable table rendering for alert labels in Feishu app cards. Omit to keep the existing setting.
	FeishuAppCardV2TableEnabled *bool `json:"feishu_app_card_v2_table_enabled,omitempty" toon:"feishu_app_card_v2_table_enabled,omitempty"`
	// Incident card fields hidden per IM app type.
	IncidentCardHiddenFields IncidentCardHiddenFields `json:"incident_card_hidden_fields,omitempty" toon:"incident_card_hidden_fields,omitempty"`
	// Slack robot message template source. Omit to keep the current content; send an empty string to clear it.
	Slack *string `json:"slack,omitempty" toon:"slack,omitempty"`
	// Slack app message template source. Omit to keep the current content; send an empty string to clear it.
	SlackApp *string `json:"slack_app,omitempty" toon:"slack_app,omitempty"`
	// SMS template source (Go `text/template` syntax). Omit to keep the current content; send an empty string to clear it.
	SMS *string `json:"sms,omitempty" toon:"sms,omitempty"`
	// Team scope. 0 for account-wide. Omit to keep the template's current team.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Microsoft Teams app message template source. Omit to keep the current content; send an empty string to clear it.
	TeamsApp *string `json:"teams_app,omitempty" toon:"teams_app,omitempty"`
	// Telegram bot message template source. Omit to keep the current content; send an empty string to clear it.
	Telegram *string `json:"telegram,omitempty" toon:"telegram,omitempty"`
	// Target template ID; obtain it from `POST /template/list`.
	TemplateID string `json:"template_id" toon:"template_id"`
	// Template name. 1–39 characters.
	TemplateName string `json:"template_name" toon:"template_name"`
	// Voice call script template source. Omit to keep the current content; send an empty string to clear it.
	Voice *string `json:"voice,omitempty" toon:"voice,omitempty"`
	// WeCom robot message template source. Omit to keep the current content; send an empty string to clear it.
	Wecom *string `json:"wecom,omitempty" toon:"wecom,omitempty"`
	// WeCom app message template source. Omit to keep the current content; send an empty string to clear it.
	WecomApp *string `json:"wecom_app,omitempty" toon:"wecom_app,omitempty"`
	// Zoom bot message template source. Omit to keep the current content; send an empty string to clear it.
	Zoom *string `json:"zoom,omitempty" toon:"zoom,omitempty"`
}

TemplateUpdateRequest is generated from the Flashduty OpenAPI schema.

type TimeFilter 

type TimeFilter struct {
	// Optional calendar ID; restricts the window to days matching the calendar.
	CalID string `json:"cal_id,omitempty" toon:"cal_id,omitempty"`
	// End of the window in `HH:MM`.
	End string `json:"end,omitempty" toon:"end,omitempty"`
	// When true, match days marked as days-off in the calendar.
	IsOff bool `json:"is_off,omitempty" toon:"is_off,omitempty"`
	// Days of the week this window repeats on. Empty means every day.
	Repeat []int64 `json:"repeat,omitempty" toon:"repeat,omitempty"`
	// Start of the window in `HH:MM`.
	Start string `json:"start,omitempty" toon:"start,omitempty"`
}

TimeFilter is generated from the Flashduty OpenAPI schema.

type Timestamp added in v0.3.0 

type Timestamp int64

Timestamp is a Unix-seconds instant as it appears on the Flashduty API wire.

It marshals to an RFC3339 string in the local timezone, so structured output is human- and LLM-readable instead of an opaque integer. It unmarshals from either a numeric epoch (the wire form) or an RFC3339 string (so a marshaled value round-trips). The zero value marshals to 0 — an unset sentinel, never a 1970 date — and is dropped by `json:",omitempty"`.

Use Timestamp only for absolute instants. Durations, cyclic-window offsets, and counts stay int64.

func (Timestamp) IsZero added in v0.3.0 

func (t Timestamp) IsZero() bool

IsZero reports whether the value is the unset sentinel (0).

func (Timestamp) MarshalJSON added in v0.3.0 

func (t Timestamp) MarshalJSON() ([]byte, error)

MarshalJSON renders a non-zero value as a quoted RFC3339 string in the local timezone; zero renders as the bare integer 0.

func (Timestamp) String added in v0.3.0 

func (t Timestamp) String() string

String renders the instant as RFC3339 in the local timezone, or "0" when unset. Non-JSON encoders (TOON, fmt) render the value through this method.

func (Timestamp) Time added in v0.3.0 

func (t Timestamp) Time() time.Time

Time returns the instant as a time.Time.

func (Timestamp) Unix added in v0.3.0 

func (t Timestamp) Unix() int64

Unix returns the raw wire value (Unix seconds).

func (*Timestamp) UnmarshalJSON added in v0.3.0 

func (t *Timestamp) UnmarshalJSON(b []byte) error

UnmarshalJSON accepts a numeric Unix-seconds epoch, a quoted integer, an RFC3339 string, or null (→ 0).

type TimestampMilli added in v0.3.0 

type TimestampMilli int64

TimestampMilli is a Unix-milliseconds instant. It has the same rendering contract as Timestamp (RFC3339 out, epoch-or-RFC3339 in, zero→0); only the wire unit differs.

func (TimestampMilli) IsZero added in v0.3.0 

func (t TimestampMilli) IsZero() bool

IsZero reports whether the value is the unset sentinel (0).

func (TimestampMilli) MarshalJSON added in v0.3.0 

func (t TimestampMilli) MarshalJSON() ([]byte, error)

MarshalJSON renders a non-zero value as a quoted RFC3339 string in the local timezone; zero renders as the bare integer 0. RFC3339Nano is used so that sub-second (millisecond) precision survives a marshal→unmarshal round-trip; it elides trailing zeros, so whole-second values render identically to a plain RFC3339 timestamp.

func (TimestampMilli) String added in v0.3.0 

func (t TimestampMilli) String() string

String renders the instant as RFC3339Nano in the local timezone (preserving sub-second precision), or "0" when unset. Non-JSON encoders (TOON, fmt) render the value through this method.

func (TimestampMilli) Time added in v0.3.0 

func (t TimestampMilli) Time() time.Time

Time returns the instant as a time.Time.

func (TimestampMilli) Unix added in v0.3.0 

func (t TimestampMilli) Unix() int64

Unix returns the raw wire value (milliseconds since the Unix epoch).

func (*TimestampMilli) UnmarshalJSON added in v0.3.0 

func (t *TimestampMilli) UnmarshalJSON(b []byte) error

UnmarshalJSON accepts a numeric Unix-milliseconds epoch, a quoted integer, an RFC3339 string, or null (→ 0).

type ToolCatalogRequest 

type ToolCatalogRequest struct {
	// Optional consistency check. Must equal the authenticated account when supplied.
	AccountID int64 `json:"account_id,omitempty" toon:"account_id,omitempty"`
	// Optional target kind; only host is supported. Inferred when omitted.
	TargetKind string `json:"target_kind,omitempty" toon:"target_kind,omitempty"`
	// Host name. Max 256 bytes; no whitespace, control characters or |.
	TargetLocator string `json:"target_locator" toon:"target_locator"`
}

ToolCatalogRequest is generated from the Flashduty OpenAPI schema.

type ToolCatalogResponse 

type ToolCatalogResponse struct {
	// Request-level business error. Omitted on success. Returned with HTTP 200 — do not rely on the status code alone.
	Error *ToolCatalogResponseError `json:"error,omitempty" toon:"error,omitempty"`
	// Resolved target. Omitted when `target_kind` was not supplied and the locator could not be uniquely inferred.
	Target *ToolCatalogResponseTarget `json:"target,omitempty" toon:"target,omitempty"`
	// Tool metadata advertised by the target's agent. Always present; an empty array when `error` is set.
	Tools []ToolCatalogResponseToolsItem `json:"tools" toon:"tools"`
}

ToolCatalogResponse is generated from the Flashduty OpenAPI schema.

type ToolCatalogResponseError 

type ToolCatalogResponseError struct {
	// Request-level error code: `target_unavailable` target unreachable, `timeout` resolution timed out, `forward_failed` cross-instance forwarding failed, `invalid_tool_result` agent returned an invalid result, `ambiguous_target_kind` target kind not uniquely inferable.
	Code string `json:"code" toon:"code"`
	// Human-readable error detail.
	Message string `json:"message" toon:"message"`
	// Returned for `ambiguous_target_kind`; lists the candidate kinds.
	TargetKinds *[]string `json:"target_kinds,omitempty" toon:"target_kinds,omitempty"`
}

ToolCatalogResponseError is generated from the Flashduty OpenAPI schema.

type ToolCatalogResponseTarget 

type ToolCatalogResponseTarget struct {
	// Resolved host target kind.
	Kind string `json:"kind" toon:"kind"`
	// Echo of the target locator from the request.
	Locator string `json:"locator" toon:"locator"`
}

ToolCatalogResponseTarget is generated from the Flashduty OpenAPI schema.

type ToolCatalogResponseToolsItem 

type ToolCatalogResponseToolsItem struct {
	// Tool capability description for UI / AI-SRE consumption.
	Description string `json:"description" toon:"description"`
	// JSON Schema for `tools[].params`.
	InputSchema map[string]any `json:"input_schema" toon:"input_schema"`
	// Tool name; pass into `/monit/tools/invoke` as `tools[].tool`.
	Name string `json:"name" toon:"name"`
	// Target kind this tool applies to.
	TargetKind string `json:"target_kind" toon:"target_kind"`
}

ToolCatalogResponseToolsItem is generated from the Flashduty OpenAPI schema.

type ToolInvokeRequest 

type ToolInvokeRequest struct {
	// Optional consistency check. Must equal the authenticated account when supplied.
	AccountID int64 `json:"account_id,omitempty" toon:"account_id,omitempty"`
	// Optional target kind; only host is supported. Inferred when omitted.
	TargetKind string `json:"target_kind,omitempty" toon:"target_kind,omitempty"`
	// Host name. Max 256 bytes; no whitespace, control characters or |.
	TargetLocator string `json:"target_locator" toon:"target_locator"`
	// Up to 8 tool calls; webapi executes them concurrently and returns results in input order.
	Tools []ToolInvokeRequestToolsItem `json:"tools" toon:"tools"`
}

ToolInvokeRequest is generated from the Flashduty OpenAPI schema.

type ToolInvokeRequestToolsItem 

type ToolInvokeRequestToolsItem struct {
	// Tool parameters matching the catalog `input_schema`. For no-arg tools pass `{}` explicitly.
	Params map[string]any `json:"params,omitempty" toon:"params,omitempty"`
	// Tool name, typically from `/monit/tools/catalog`.
	Tool string `json:"tool" toon:"tool"`
}

ToolInvokeRequestToolsItem is generated from the Flashduty OpenAPI schema.

type ToolInvokeResponse 

type ToolInvokeResponse struct {
	// Request-level business error. Omitted on success. Returned with HTTP 200 — do not rely on the status code alone.
	Error *ToolInvokeResponseError `json:"error,omitempty" toon:"error,omitempty"`
	// Per-tool results, aligned with the request `tools[]` order. Empty when a request-level `error` is present.
	Results []ToolInvokeResponseResultsItem `json:"results" toon:"results"`
	// Resolved target. Omitted when `target_kind` was not supplied and the locator could not be uniquely inferred.
	Target *ToolInvokeResponseTarget `json:"target,omitempty" toon:"target,omitempty"`
}

ToolInvokeResponse is generated from the Flashduty OpenAPI schema.

type ToolInvokeResponseError 

type ToolInvokeResponseError struct {
	// Request-level error code: `target_unavailable` target unreachable, `forward_failed` cross-instance forwarding failed, `ambiguous_target_kind` target kind not uniquely inferable.
	Code string `json:"code" toon:"code"`
	// Human-readable error detail.
	Message string `json:"message" toon:"message"`
	// Returned only when `code` is `ambiguous_target_kind`, listing the candidate target kinds matched by the locator; omitted otherwise.
	TargetKinds *[]string `json:"target_kinds,omitempty" toon:"target_kinds,omitempty"`
}

ToolInvokeResponseError is generated from the Flashduty OpenAPI schema.

type ToolInvokeResponseResultsItem 

type ToolInvokeResponseResultsItem struct {
	// Tool business payload. Present only on success. Webapi already unwraps the monit-agent result envelope, so there is no nested `data.data`.
	Data *map[string]any `json:"data,omitempty" toon:"data,omitempty"`
	// Per-tool failure. Present only on failure, and mutually exclusive with `data` / `summary` / `truncated`.
	Error *ToolInvokeResponseResultsItemError `json:"error,omitempty" toon:"error,omitempty"`
	// Request params echoed back by webapi. Normalized to `{}` when the request omitted them or sent null.
	Params map[string]any `json:"params" toon:"params"`
	// Human/LLM-readable one-line distillation of the result. Present only when non-empty.
	Summary *string `json:"summary,omitempty" toon:"summary,omitempty"`
	// Tool name, aligned one-to-one with the request `tools[]` order.
	Tool string `json:"tool" toon:"tool"`
	// Agent-executed tool version. Omitted when the failure occurred before the agent picked a version.
	ToolVersion *string `json:"tool_version,omitempty" toon:"tool_version,omitempty"`
	// Present only when the result was actually truncated — the field's presence is the signal, so there is no redundant `truncated: true`.
	Truncated *ToolInvokeResponseResultsItemTruncated `json:"truncated,omitempty" toon:"truncated,omitempty"`
}

ToolInvokeResponseResultsItem is generated from the Flashduty OpenAPI schema.

type ToolInvokeResponseResultsItemError 

type ToolInvokeResponseResultsItemError struct {
	// Common WebAPI codes: `timeout`, `target_unavailable`, `invalid_tool_result`, `internal`, `invalid_args`, `unsupported_syntax`, `path_not_found`, and `catalog_changed`. Agent-specific tool errors may also be returned unchanged.
	Code string `json:"code" toon:"code"`
	// Human-readable detail for this tool's failure; agent-side messages may be forwarded verbatim.
	Message string `json:"message" toon:"message"`
}

ToolInvokeResponseResultsItemError is generated from the Flashduty OpenAPI schema.

type ToolInvokeResponseResultsItemTruncated added in v0.5.7 

type ToolInvokeResponseResultsItemTruncated struct {
	// Why the result was truncated.
	Reason string `json:"reason" toon:"reason"`
}

ToolInvokeResponseResultsItemTruncated is generated from the Flashduty OpenAPI schema.

type ToolInvokeResponseTarget 

type ToolInvokeResponseTarget struct {
	// Resolved host target kind.
	Kind string `json:"kind" toon:"kind"`
	// Echo of the target locator from the request.
	Locator string `json:"locator" toon:"locator"`
}

ToolInvokeResponseTarget is generated from the Flashduty OpenAPI schema.

type TryLinkPersonRequest added in v0.5.4 

type TryLinkPersonRequest struct {
	// IM integration ID; obtain it from `POST /datasource/im/war-room-enabled/list`.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
}

TryLinkPersonRequest is generated from the Flashduty OpenAPI schema.

type TryLinkPersonResponse added in v0.5.4 

type TryLinkPersonResponse struct {
	// Person IDs newly linked during this call.
	NewLinkedPersonIDs []int64 `json:"new_linked_person_ids" toon:"new_linked_person_ids"`
}

TryLinkPersonResponse is generated from the Flashduty OpenAPI schema.

type UnackIncidentRequest 

type UnackIncidentRequest struct {
	// Incident IDs to unacknowledge. At most 100 per call.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
}

UnackIncidentRequest is generated from the Flashduty OpenAPI schema.

type UnsubscribeRuleItem 

type UnsubscribeRuleItem struct {
	// ID of the account the rule belongs to.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// ID of the channel the rule belongs to.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Creation time, Unix timestamp in seconds.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Deletion time, Unix timestamp in seconds. Omitted unless the rule is soft-deleted; deleted rules are excluded from list responses.
	DeletedAt Timestamp `json:"deleted_at" toon:"deleted_at"`
	// Rule description.
	Description string `json:"description" toon:"description"`
	// Alert event match conditions (OR-of-AND); matching events are discarded entirely. Empty means the rule matches nothing.
	Filters FilterGroup `json:"filters" toon:"filters"`
	// Rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Rule status: `enabled` or `disabled`; deleted rules never appear in the list.
	Status string `json:"status" toon:"status"`
	// Last update time, Unix timestamp in seconds.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// ID of the user who last updated the rule.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

UnsubscribeRuleItem is generated from the Flashduty OpenAPI schema.

type UpdateChannelRequest 

type UpdateChannelRequest struct {
	// Auto-resolve timing mode: `trigger` starts the timer when the incident triggers, `update` restarts it on every alert update. Applied only when `auto_resolve_timeout` is also present in the request.
	AutoResolveMode string `json:"auto_resolve_mode,omitempty" toon:"auto_resolve_mode,omitempty"`
	// Auto-resolve timeout in seconds. 0 disables auto-resolve. Max 30 days.
	AutoResolveTimeout *int64 `json:"auto_resolve_timeout,omitempty" toon:"auto_resolve_timeout,omitempty"`
	// ID of the channel to update; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// New channel name. 1 to 59 characters.
	ChannelName *string `json:"channel_name,omitempty" toon:"channel_name,omitempty"`
	// New description. Up to 500 characters.
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// Disable automatic incident closing.
	DisableAutoClose *bool `json:"disable_auto_close,omitempty" toon:"disable_auto_close,omitempty"`
	// Disable outlier incident detection.
	DisableOutlierDetection *bool `json:"disable_outlier_detection,omitempty" toon:"disable_outlier_detection,omitempty"`
	// Alert event merge configuration. Updated only when present.
	EventGroup EventGroup `json:"event_group,omitzero" toon:"event_group,omitempty"`
	// Flapping detection configuration.
	Flapping Flapping `json:"flapping,omitzero" toon:"flapping,omitempty"`
	// Alert grouping configuration.
	Group Group `json:"group,omitzero" toon:"group,omitempty"`
	// Allow external reporters to file incidents into this channel.
	IsExternalReportEnabled *bool `json:"is_external_report_enabled,omitempty" toon:"is_external_report_enabled,omitempty"`
	// When true, the channel is visible only to its managing teams.
	IsPrivate *bool `json:"is_private,omitempty" toon:"is_private,omitempty"`
	// Additional teams that can manage the channel. Up to 3 entries.
	ManagingTeamIDs []int64 `json:"managing_team_ids,omitempty" toon:"managing_team_ids,omitempty"`
	// New owning team ID; obtain it from `POST /team/list`.
	TeamID *int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
}

UpdateChannelRequest is generated from the Flashduty OpenAPI schema.

type UpdateChannelResponse 

type UpdateChannelResponse struct {
	// Newly generated token for external reporters. Only returned when `is_external_report_enabled` is set to `true` in the request. Callers should store this value; it cannot be retrieved afterwards.
	ExternalReportToken string `json:"external_report_token" toon:"external_report_token"`
}

UpdateChannelResponse is generated from the Flashduty OpenAPI schema.

type UpdateDropRuleRequest 

type UpdateDropRuleRequest struct {
	// Owning channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Rule description, up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Alert event match conditions (OR-of-AND); matching events are discarded entirely. When empty, the rule matches nothing.
	Filters FilterGroup `json:"filters,omitempty" toon:"filters,omitempty"`
	// Drop rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name, 1 to 39 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
}

UpdateDropRuleRequest is generated from the Flashduty OpenAPI schema.

type UpdateEscalationRuleRequest 

type UpdateEscalationRuleRequest struct {
	// Delay window in seconds. 0 disables delay.
	AggrWindow int64 `json:"aggr_window,omitempty" toon:"aggr_window,omitempty"`
	// Owning channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Rule description, up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Incident-level match conditions (OR-of-AND tree): the rule is matched against the incident the alert was grouped into, not against the alert itself. Omit or leave empty to apply the rule to all incidents in the channel.
	Filters FilterGroup `json:"filters,omitempty" toon:"filters,omitempty"`
	// Escalation levels in order. At least one level is required.
	Layers []EscalateLayer `json:"layers" toon:"layers"`
	// Evaluation priority. Lower runs first.
	Priority *int64 `json:"priority,omitempty" toon:"priority,omitempty"`
	// Escalation rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name, 1 to 39 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Notification template ID (MongoDB ObjectID).
	TemplateID string `json:"template_id" toon:"template_id"`
	// Optional recurring time windows during which the rule applies.
	TimeFilters []TimeFilter `json:"time_filters,omitempty" toon:"time_filters,omitempty"`
}

UpdateEscalationRuleRequest is generated from the Flashduty OpenAPI schema.

type UpdateFieldRequest 

type UpdateFieldRequest struct {
	// Replacement default value. Type must match the field's existing `field_type`.
	DefaultValue any `json:"default_value,omitempty" toon:"default_value,omitempty"`
	// New description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// New display name. Must remain unique within the account.
	DisplayName string `json:"display_name,omitempty" toon:"display_name,omitempty"`
	// Field ID — 24-character hex ObjectID.
	FieldID string `json:"field_id" toon:"field_id"`
	// Replacement options list. Must obey the same per-type rules as create. Note: the update always overwrites `display_name`, `description`, `options`, and `default_value` with the submitted values, so for `single_select`/`multi_select` fields a non-empty `options` list must be sent on every update.
	Options []string `json:"options,omitempty" toon:"options,omitempty"`
}

UpdateFieldRequest is generated from the Flashduty OpenAPI schema.

type UpdateIncidentCommentTypeRequest added in v0.8.0 

type UpdateIncidentCommentTypeRequest struct {
	// New label color as a hex value in #RRGGBB format. Normalized to uppercase.
	Color string `json:"color,omitempty" toon:"color,omitempty"`
	// ID of the comment type to update (24-character hex ObjectID).
	CommentTypeID string `json:"comment_type_id" toon:"comment_type_id"`
	// New display name. Trimmed before storing; must be unique within the account (case-insensitive). At most 40 characters.
	Name string `json:"name,omitempty" toon:"name,omitempty"`
}

UpdateIncidentCommentTypeRequest is generated from the Flashduty OpenAPI schema.

type UpdateIncidentFieldsRequest 

type UpdateIncidentFieldsRequest struct {
	// New description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// New impact description.
	Impact string `json:"impact,omitempty" toon:"impact,omitempty"`
	// Incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// New severity: `Info`, `Warning` or `Critical` (most severe).
	IncidentSeverity string `json:"incident_severity,omitempty" toon:"incident_severity,omitempty"`
	// New resolution notes.
	Resolution string `json:"resolution,omitempty" toon:"resolution,omitempty"`
	// New root cause analysis.
	RootCause string `json:"root_cause,omitempty" toon:"root_cause,omitempty"`
	// New incident title.
	Title string `json:"title,omitempty" toon:"title,omitempty"`
}

UpdateIncidentFieldsRequest is generated from the Flashduty OpenAPI schema.

type UpdateInhibitRuleRequest 

type UpdateInhibitRuleRequest struct {
	// Owning channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Rule description, up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Field keys whose values must be equal between the source (inhibiting) alert and the target (suppressed) alert, e.g. `data_source_id` or `labels.cluster`.
	Equals []string `json:"equals" toon:"equals"`
	// When true, matching alert events are discarded entirely; when false, alerts are still recorded but marked as muted by this rule.
	IsDirectlyDiscard bool `json:"is_directly_discard,omitempty" toon:"is_directly_discard,omitempty"`
	// Inhibit rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name, 1 to 39 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// Conditions the source alert must match, evaluated against stored active alerts. Supported keys: `status`, `incident_status`, `alert_status`, `severity`, `incident_severity`, `alert_severity`, `title`, `description`, or any `labels.<name>`. Empty makes the rule inert.
	SourceFilters FilterGroup `json:"source_filters,omitempty" toon:"source_filters,omitempty"`
	// Conditions the incoming target alert event must match to be suppressed; empty means every event is a target.
	TargetFilters FilterGroup `json:"target_filters,omitempty" toon:"target_filters,omitempty"`
}

UpdateInhibitRuleRequest is generated from the Flashduty OpenAPI schema.

type UpdateSilenceRuleRequest 

type UpdateSilenceRuleRequest struct {
	// Owning channel ID; obtain it from `POST /channel/list`.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Rule description, up to 500 characters.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Match conditions for the alerts to silence; required and must not be empty.
	Filters FilterGroup `json:"filters,omitempty" toon:"filters,omitempty"`
	// When true, the silence rule is automatically deleted after its time window expires. Defaults to false.
	IsAutoDelete bool `json:"is_auto_delete,omitempty" toon:"is_auto_delete,omitempty"`
	// When true, matching alert events are discarded entirely; when false, alerts are still recorded but marked as muted by this rule.
	IsDirectlyDiscard bool `json:"is_directly_discard,omitempty" toon:"is_directly_discard,omitempty"`
	// Silence rule ID (MongoDB ObjectID).
	RuleID string `json:"rule_id" toon:"rule_id"`
	// Rule name, 1 to 39 characters.
	RuleName string `json:"rule_name" toon:"rule_name"`
	// One-off silence window. Mutually exclusive with `time_filters`; exactly one of the two must be set.
	TimeFilter OnceTimeFilter `json:"time_filter,omitzero" toon:"time_filter,omitempty"`
	// Recurring time windows. Mutually exclusive with `time_filter`.
	TimeFilters []TimeFilter `json:"time_filters,omitempty" toon:"time_filters,omitempty"`
}

UpdateSilenceRuleRequest is generated from the Flashduty OpenAPI schema.

type UpdateStatusPageChangeRequest 

type UpdateStatusPageChangeRequest struct {
	// Target change ID; obtain it from `GET /status-page/change/list`.
	ChangeID int64 `json:"change_id" toon:"change_id"`
	// Linked event IDs. Pass the full replacement list.
	LinkedChanges []string `json:"linked_changes,omitempty" toon:"linked_changes,omitempty"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Member IDs responsible for this event. Pass the full replacement list.
	Responders []int64 `json:"responders,omitempty" toon:"responders,omitempty"`
	// New event title, up to 255 characters. Omit to keep the existing value.
	Title *string `json:"title,omitempty" toon:"title,omitempty"`
}

UpdateStatusPageChangeRequest is generated from the Flashduty OpenAPI schema.

type UpdateStatusPageChangeTimelineRequest 

type UpdateStatusPageChangeTimelineRequest struct {
	// New update timestamp in Unix seconds.
	AtSeconds int64 `json:"at_seconds,omitempty" toon:"at_seconds,omitempty"`
	// Owning change ID; obtain it from `GET /status-page/change/list`.
	ChangeID int64 `json:"change_id" toon:"change_id"`
	// New update description (Markdown).
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Target timeline update ID; obtain it from `GET /status-page/change/info`.
	UpdateID string `json:"update_id" toon:"update_id"`
}

UpdateStatusPageChangeTimelineRequest is generated from the Flashduty OpenAPI schema.

type UpdateStatusPageRequest added in v0.6.0 

type UpdateStatusPageRequest struct {
	// Get-in-touch contact, such as a mailto or website URL. Omit or pass null to keep the existing value.
	ContactInfo *string `json:"contact_info,omitempty" toon:"contact_info,omitempty"`
	// Custom domain for a public status page. Omit or pass null to keep the existing value.
	CustomDomain *string `json:"custom_domain,omitempty" toon:"custom_domain,omitempty"`
	// Custom navigation links shown on the status page. Omit or pass an empty array to keep the current links.
	CustomLinks []map[string]string `json:"custom_links,omitempty" toon:"custom_links,omitempty"`
	DarkLogo *string `json:"dark_logo,omitempty" toon:"dark_logo,omitempty"`
	// How change dates are displayed. Leave empty to keep the current value. `calendar` uses a calendar view; `list` uses a list view.
	DateView *string `json:"date_view,omitempty" toon:"date_view,omitempty"`
	// How uptime is displayed. Leave empty to keep the current value. `chart_and_percentage` shows both chart and percentage; `chart` shows only the chart; `none` hides uptime.
	DisplayUptimeMode *string `json:"display_uptime_mode,omitempty" toon:"display_uptime_mode,omitempty"`
	// Favicon of the status page. Omit or pass null to keep the existing value.
	Favicon *string `json:"favicon,omitempty" toon:"favicon,omitempty"`
	Logo *string `json:"logo,omitempty" toon:"logo,omitempty"`
	// URL opened when the logo is clicked. Omit or pass null to keep the existing value.
	LogoURL *string `json:"logo_url,omitempty" toon:"logo_url,omitempty"`
	// Display name of the status page. Omit or pass null to keep the existing value.
	Name *string `json:"name,omitempty" toon:"name,omitempty"`
	// Footer content shown on the status page. Omit or pass null to keep the existing value.
	PageFooter *string `json:"page_footer,omitempty" toon:"page_footer,omitempty"`
	// Header content shown on the status page. Omit or pass null to keep the existing value.
	PageHeader *string `json:"page_header,omitempty" toon:"page_header,omitempty"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Browser title shown for the status page. Omit or pass null to keep the existing value.
	PageTitle *string `json:"page_title,omitempty" toon:"page_title,omitempty"`
	// Subscription channel toggles. Omit or pass null to keep the existing value.
	Subscription StatusPageSubscriptionItem `json:"subscription,omitzero" toon:"subscription,omitempty"`
	// Preferred event template type: `pre_defined` or `message`. Omit or pass null to keep the existing value.
	TemplatePreference *string `json:"template_preference,omitempty" toon:"template_preference,omitempty"`
	// URL-safe slug, unique per account and page type. Omit or pass null to keep the existing value.
	URLName *string `json:"url_name,omitempty" toon:"url_name,omitempty"`
}

UpdateStatusPageRequest is generated from the Flashduty OpenAPI schema.

type UpdateWorkItemRequest added in v0.8.0 

type UpdateWorkItemRequest struct {
	// New description (max 65,535 characters).
	Description *string `json:"description,omitempty" toon:"description,omitempty"`
	// New client-defined priority (max 64 characters).
	Priority *string `json:"priority,omitempty" toon:"priority,omitempty"`
	// New client-defined status (max 64 characters).
	Status *string `json:"status,omitempty" toon:"status,omitempty"`
	// New title (max 512 characters).
	Title *string `json:"title,omitempty" toon:"title,omitempty"`
	// Current item version for optimistic locking. Must match the stored version.
	Version int64 `json:"version" toon:"version"`
	// Work item ID (opaque string, max 128 characters).
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

UpdateWorkItemRequest is generated from the Flashduty OpenAPI schema.

type UpsertPostMortemTemplateRequest added in v0.5.4 

type UpsertPostMortemTemplateRequest struct {
	// BlockNote JSON template content.
	Content string `json:"content" toon:"content"`
	// Markdown version of the template content.
	ContentMarkdown string `json:"content_markdown,omitempty" toon:"content_markdown,omitempty"`
	// Template description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// Template name.
	Name string `json:"name" toon:"name"`
	// Managing team ID. Required when creating a custom template.
	TeamID int64 `json:"team_id,omitempty" toon:"team_id,omitempty"`
	// Template ID. Omit to create a new template; provide it to update an existing template.
	TemplateID string `json:"template_id,omitempty" toon:"template_id,omitempty"`
}

UpsertPostMortemTemplateRequest is generated from the Flashduty OpenAPI schema.

type UpsertRouteRequest 

type UpsertRouteRequest struct {
	// Ordered list of case branches. Cases are evaluated top to bottom.
	Cases []RouteCase `json:"cases,omitempty" toon:"cases,omitempty"`
	// Fallback branch used when no case matches.
	Default RouteDefault `json:"default,omitzero" toon:"default,omitempty"`
	// Integration the rule belongs to.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Optional sections that group consecutive cases for display.
	Sections []RouteSection `json:"sections,omitempty" toon:"sections,omitempty"`
	// Reserved for optimistic concurrency control; currently ignored — the server increments `version` automatically on every upsert.
	Version int64 `json:"version,omitempty" toon:"version,omitempty"`
}

UpsertRouteRequest is generated from the Flashduty OpenAPI schema.

type UpsertStatusPageComponentRequest added in v0.5.4 

type UpsertStatusPageComponentRequest struct {
	// Components to create or update.
	Components []UpsertStatusPageComponentRequestComponentsItem `json:"components" toon:"components"`
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
}

UpsertStatusPageComponentRequest is generated from the Flashduty OpenAPI schema.

type UpsertStatusPageComponentRequestComponentsItem added in v0.5.4 

type UpsertStatusPageComponentRequestComponentsItem struct {
	// Time the component became (or becomes) available, in Unix seconds. On create, defaults to the current time; on update, replaces the stored value.
	AvailableSinceSeconds int64 `json:"available_since_seconds,omitempty" toon:"available_since_seconds,omitempty"`
	// Component ID. Omit to create a new component; supply to update an existing one.
	ComponentID string `json:"component_id,omitempty" toon:"component_id,omitempty"`
	// Component description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// When true, the component is hidden entirely from summary endpoints.
	HideAll bool `json:"hide_all,omitempty" toon:"hide_all,omitempty"`
	// When true, uptime data is hidden from summary responses.
	HideUptime bool `json:"hide_uptime,omitempty" toon:"hide_uptime,omitempty"`
	// Component display name.
	Name string `json:"name" toon:"name"`
	// Display order within its section.
	OrderID int64 `json:"order_id,omitempty" toon:"order_id,omitempty"`
	// Parent section ID. Omit to place the component at the top level.
	SectionID string `json:"section_id,omitempty" toon:"section_id,omitempty"`
}

UpsertStatusPageComponentRequestComponentsItem is generated from the Flashduty OpenAPI schema.

type UpsertStatusPageComponentResponse added in v0.5.4 

type UpsertStatusPageComponentResponse struct {
	// IDs of the created or updated components, in the same order as the request.
	ComponentIDs []string `json:"component_ids" toon:"component_ids"`
}

UpsertStatusPageComponentResponse is generated from the Flashduty OpenAPI schema.

type UpsertStatusPageSectionRequest added in v0.5.4 

type UpsertStatusPageSectionRequest struct {
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Sections to create or update.
	Sections []UpsertStatusPageSectionRequestSectionsItem `json:"sections" toon:"sections"`
}

UpsertStatusPageSectionRequest is generated from the Flashduty OpenAPI schema.

type UpsertStatusPageSectionRequestSectionsItem added in v0.5.4 

type UpsertStatusPageSectionRequestSectionsItem struct {
	// Section description.
	Description string `json:"description,omitempty" toon:"description,omitempty"`
	// When true, the entire section is hidden from summary endpoints.
	HideAll bool `json:"hide_all,omitempty" toon:"hide_all,omitempty"`
	// When true, uptime data for all components in this section is hidden.
	HideUptime bool `json:"hide_uptime,omitempty" toon:"hide_uptime,omitempty"`
	// Section display name.
	Name string `json:"name" toon:"name"`
	// Display order.
	OrderID int64 `json:"order_id,omitempty" toon:"order_id,omitempty"`
	// Section ID. Omit to create a new section; supply to update an existing one.
	SectionID string `json:"section_id,omitempty" toon:"section_id,omitempty"`
}

UpsertStatusPageSectionRequestSectionsItem is generated from the Flashduty OpenAPI schema.

type UpsertStatusPageSectionResponse added in v0.5.4 

type UpsertStatusPageSectionResponse struct {
	// IDs of the created or updated sections, in the same order as the request.
	SectionIDs []string `json:"section_ids" toon:"section_ids"`
}

UpsertStatusPageSectionResponse is generated from the Flashduty OpenAPI schema.

type UpsertStatusPageTemplateRequest added in v0.5.4 

type UpsertStatusPageTemplateRequest struct {
	// Status page ID; obtain it from `GET /status-page/list`.
	PageID int64 `json:"page_id" toon:"page_id"`
	// Template content. Shape depends on `type`: a predefined event template for `pre_defined`, a message template for `message`.
	Template any `json:"template" toon:"template"`
	// Template category. `pre_defined` for predefined event templates; `message` for notification message templates.
	Type string `json:"type" toon:"type"`
}

UpsertStatusPageTemplateRequest is generated from the Flashduty OpenAPI schema.

type UpsertStatusPageTemplateResponse added in v0.5.4 

type UpsertStatusPageTemplateResponse struct {
	// ID of the created or updated template.
	TemplateID string `json:"template_id" toon:"template_id"`
}

UpsertStatusPageTemplateResponse is generated from the Flashduty OpenAPI schema.

type WakeIncidentRequest 

type WakeIncidentRequest struct {
	// Incident IDs to wake. At most 100 per call.
	IncidentIDs []string `json:"incident_ids" toon:"incident_ids"`
}

WakeIncidentRequest is generated from the Flashduty OpenAPI schema.

type WarRoom 

type WarRoom struct {
	// Chat/group ID on the IM side.
	ChatID string `json:"chat_id" toon:"chat_id"`
	// Chat/group display name.
	ChatName string `json:"chat_name" toon:"chat_name"`
	// Join link for the war room, if provided by the IM.
	ShareLink string `json:"share_link" toon:"share_link"`
}

WarRoom is generated from the Flashduty OpenAPI schema.

type WarRoomDataSourceItem added in v0.4.0 

type WarRoomDataSourceItem struct {
	// Account this integration belongs to.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Plugin category; `im` for the IM integrations returned here.
	Category string `json:"category" toon:"category"`
	// Unix timestamp in seconds when the integration was created.
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Person who created the integration.
	CreatorID int64 `json:"creator_id" toon:"creator_id"`
	// Integration ID.
	DataSourceID int64 `json:"data_source_id" toon:"data_source_id"`
	// Integration description.
	Description string `json:"description" toon:"description"`
	// Legacy exclusive-integration linkage; deprecated.
	ExclusiveDataSourceID int64 `json:"exclusive_data_source_id" toon:"exclusive_data_source_id"`
	// Integration ID, alias of data_source_id.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Push key used by alert sources to send to this integration.
	IntegrationKey string `json:"integration_key" toon:"integration_key"`
	// Unix timestamp in seconds of the most recent activity in this datasource. Always `0` — this endpoint does not populate the field.
	LastTime Timestamp `json:"last_time" toon:"last_time"`
	// Integration name.
	Name string `json:"name" toon:"name"`
	// Whether the integration is read-only.
	NoEditable bool `json:"no_editable" toon:"no_editable"`
	// Plugin ID backing this integration.
	PluginID int64 `json:"plugin_id" toon:"plugin_id"`
	// Plugin type identifier of the IM integration, for example `feishu_app`, `dingtalk_app`, `wecom_app`, `slack_app`, or `teams_app`.
	PluginType string `json:"plugin_type" toon:"plugin_type"`
	// Localized display name of the integration plugin type.
	PluginTypeName string `json:"plugin_type_name" toon:"plugin_type_name"`
	// External reference ID of the integration.
	RefID string `json:"ref_id" toon:"ref_id"`
	// Plugin-specific configuration of the integration.
	Settings map[string]any `json:"settings" toon:"settings"`
	// Integration status: `enabled` or `disabled`. Deleted integrations are never returned.
	Status string `json:"status" toon:"status"`
	// Team that owns this integration.
	TeamID int64 `json:"team_id" toon:"team_id"`
	// Unix timestamp in seconds when the integration was last updated.
	UpdatedAt Timestamp `json:"updated_at" toon:"updated_at"`
	// Person who last updated the integration.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
}

WarRoomDataSourceItem is generated from the Flashduty OpenAPI schema.

type WarRoomItem 

type WarRoomItem struct {
	// Account ID.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Chat/group ID on the IM side.
	ChatID string `json:"chat_id" toon:"chat_id"`
	// Creation timestamp (seconds).
	CreatedAt Timestamp `json:"created_at" toon:"created_at"`
	// Member ID that created the war room.
	CreatedBy int64 `json:"created_by" toon:"created_by"`
	// Associated incident ID (MongoDB ObjectID).
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// IM integration ID.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// IM plugin type (e.g. `feishu`, `dingtalk`, `wecom`, `slack`).
	PluginType string `json:"plugin_type" toon:"plugin_type"`
	// War room record status: `enabled` active, `deleted` disbanded.
	Status string `json:"status" toon:"status"`
}

WarRoomItem is generated from the Flashduty OpenAPI schema.

type WarRoomPersonItem added in v0.4.0 

type WarRoomPersonItem struct {
	// Account this person belongs to.
	AccountID int64 `json:"account_id" toon:"account_id"`
	// Role the person holds in the related context.
	As string `json:"as" toon:"as"`
	// URL of the person's avatar image.
	Avatar string `json:"avatar" toon:"avatar"`
	// Email address of the person.
	Email string `json:"email" toon:"email"`
	// Preferred language locale of the person.
	Locale string `json:"locale" toon:"locale"`
	// Person ID.
	PersonID int64 `json:"person_id" toon:"person_id"`
	// Display name of the person.
	PersonName string `json:"person_name" toon:"person_name"`
	// Phone number of the person.
	Phone string `json:"phone" toon:"phone"`
	// Current status of the person.
	Status string `json:"status" toon:"status"`
	// Time zone of the person.
	TimeZone string `json:"time_zone" toon:"time_zone"`
}

WarRoomPersonItem is generated from the Flashduty OpenAPI schema.

type WebhookHistoryDetail 

type WebhookHistoryDetail struct {
	// Attempt sequence number.
	Attempt int64 `json:"attempt" toon:"attempt"`
	// Channel ID when applicable.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Name of the associated channel, resolved at query time.
	ChannelName string `json:"channel_name" toon:"channel_name"`
	// Total elapsed time of the attempt in milliseconds.
	Duration int64 `json:"duration" toon:"duration"`
	// Destination URL.
	Endpoint string `json:"endpoint" toon:"endpoint"`
	// Error message when delivery failed.
	ErrorMessage string `json:"error_message" toon:"error_message"`
	// Event ID.
	EventID string `json:"event_id" toon:"event_id"`
	// Event time formatted as `YYYY-MM-DD HH:MM:SS.ffffff`.
	EventTime string `json:"event_time" toon:"event_time"`
	// Event type code. `i_*` values are incident events (for example `i_new` = incident created); `a_*` values are alert events (for example `a_new` = alert triggered).
	EventType string `json:"event_type" toon:"event_type"`
	// Integration ID.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Source object ID.
	RefID string `json:"ref_id" toon:"ref_id"`
	// Title of the source incident or alert, resolved at query time.
	RefTitle string `json:"ref_title" toon:"ref_title"`
	// Outbound request body payload.
	RequestBody string `json:"request_body" toon:"request_body"`
	// Serialized outbound request headers.
	RequestHeaders string `json:"request_headers" toon:"request_headers"`
	// Response body.
	ResponseBody string `json:"response_body" toon:"response_body"`
	// Serialized response headers.
	ResponseHeaders string `json:"response_headers" toon:"response_headers"`
	// Delivery outcome.
	Status string `json:"status" toon:"status"`
	// HTTP status code.
	StatusCode int64 `json:"status_code" toon:"status_code"`
	// Source object kind: `incident` or `alert`.
	WebhookType string `json:"webhook_type" toon:"webhook_type"`
}

WebhookHistoryDetail is generated from the Flashduty OpenAPI schema.

type WebhookHistoryItem 

type WebhookHistoryItem struct {
	// Attempt sequence number.
	Attempt int64 `json:"attempt" toon:"attempt"`
	// Channel ID associated with the event, when applicable.
	ChannelID int64 `json:"channel_id" toon:"channel_id"`
	// Total elapsed time of the attempt in milliseconds.
	Duration int64 `json:"duration" toon:"duration"`
	// Destination URL.
	Endpoint string `json:"endpoint" toon:"endpoint"`
	// Error message when delivery failed.
	ErrorMessage string `json:"error_message" toon:"error_message"`
	// Unique event identifier for the delivery attempt.
	EventID string `json:"event_id" toon:"event_id"`
	// Event time formatted as `YYYY-MM-DD HH:MM:SS.ffffff`.
	EventTime string `json:"event_time" toon:"event_time"`
	// Event type code. `i_*` values are incident events (for example `i_new` = incident created); `a_*` values are alert events (for example `a_new` = alert triggered).
	EventType string `json:"event_type" toon:"event_type"`
	// Integration ID that triggered the webhook.
	IntegrationID int64 `json:"integration_id" toon:"integration_id"`
	// Source object ID (incident ID or alert ID).
	RefID string `json:"ref_id" toon:"ref_id"`
	// Outbound request body payload.
	RequestBody string `json:"request_body" toon:"request_body"`
	// Serialized outbound request headers.
	RequestHeaders string `json:"request_headers" toon:"request_headers"`
	// Response body returned by the destination.
	ResponseBody string `json:"response_body" toon:"response_body"`
	// Serialized response headers from the destination.
	ResponseHeaders string `json:"response_headers" toon:"response_headers"`
	// Delivery outcome.
	Status string `json:"status" toon:"status"`
	// HTTP status code returned by the destination.
	StatusCode int64 `json:"status_code" toon:"status_code"`
	// Source object kind: `incident` or `alert`.
	WebhookType string `json:"webhook_type" toon:"webhook_type"`
}

WebhookHistoryItem is generated from the Flashduty OpenAPI schema.

type WorkItemCreateResult added in v0.8.0 

type WorkItemCreateResult struct {
	// Assignee member IDs that were newly added (and notified).
	AddedAssigneeIDs []int64 `json:"added_assignee_ids" toon:"added_assignee_ids"`
	// True when the call replayed an earlier request with the same idempotency key and no new item was created.
	IdempotentReplay bool         `json:"idempotent_replay" toon:"idempotent_replay"`
	Item             WorkItemItem `json:"item" toon:"item"`
}

WorkItemCreateResult is generated from the Flashduty OpenAPI schema.

type WorkItemItem added in v0.8.0 

type WorkItemItem struct {
	// Member IDs of the current assignees. Never null; an empty array means unassigned.
	AssigneeIDs []int64 `json:"assignee_ids" toon:"assignee_ids"`
	// Conversion time as a Unix timestamp in seconds. Present only after conversion.
	ConvertedAtSeconds Timestamp `json:"converted_at_seconds" toon:"converted_at_seconds"`
	// Member ID of the operator who converted the action into a follow-up. Present only after conversion.
	ConvertedBy int64 `json:"converted_by" toon:"converted_by"`
	// Creation time as a Unix timestamp in seconds.
	CreatedAtSeconds Timestamp `json:"created_at_seconds" toon:"created_at_seconds"`
	// Member ID of the creator.
	CreatedBy int64 `json:"created_by" toon:"created_by"`
	// Optional longer description (max 65,535 characters).
	Description string `json:"description" toon:"description"`
	// Incident ID (MongoDB ObjectID) the item is anchored to.
	IncidentID string `json:"incident_id" toon:"incident_id"`
	// `action` for an item anchored to an active incident; `follow_up` for a post-mortem follow-up.
	ItemType string `json:"item_type" toon:"item_type"`
	// Original identifier of the legacy follow-up this item was migrated from. Present only when `source_kind` is `legacy_follow_up`.
	LegacySourceID string `json:"legacy_source_id" toon:"legacy_source_id"`
	// Post-mortem ID (32-character hex string). Present on follow-up items once bound to a post-mortem.
	PostMortemID string `json:"post_mortem_id" toon:"post_mortem_id"`
	// Optional client-defined priority (max 64 characters).
	Priority string `json:"priority" toon:"priority"`
	// `native` for items created through this API; `legacy_follow_up` for items migrated from legacy post-mortem follow-ups.
	SourceKind string `json:"source_kind" toon:"source_kind"`
	// Client-defined status (max 64 characters). There is no fixed state machine.
	Status string `json:"status" toon:"status"`
	// Item title (max 512 characters).
	Title string `json:"title" toon:"title"`
	// Last update time as a Unix timestamp in seconds.
	UpdatedAtSeconds Timestamp `json:"updated_at_seconds" toon:"updated_at_seconds"`
	// Member ID of the last updater.
	UpdatedBy int64 `json:"updated_by" toon:"updated_by"`
	// Optimistic-locking version, incremented on every mutation.
	Version int64 `json:"version" toon:"version"`
	// Work item ID (opaque string, max 128 characters).
	WorkItemID string `json:"work_item_id" toon:"work_item_id"`
}

WorkItemItem is generated from the Flashduty OpenAPI schema.

type WorkItemListResult added in v0.8.0 

type WorkItemListResult struct {
	// True when more results are available.
	HasMore bool `json:"has_more" toon:"has_more"`
	// True when the call replayed an earlier request with the same idempotency key.
	IdempotentReplay bool `json:"idempotent_replay" toon:"idempotent_replay"`
	// Work items for the current page.
	Items []WorkItemItem `json:"items" toon:"items"`
	// Cursor for the next page. Pass it as `cursor`; absent when there are no more results.
	NextCursor string `json:"next_cursor" toon:"next_cursor"`
}

WorkItemListResult is generated from the Flashduty OpenAPI schema.

type WorkItemMutationResult added in v0.8.0 

type WorkItemMutationResult struct {
	// Assignee member IDs that were newly added (and notified).
	AddedAssigneeIDs []int64 `json:"added_assignee_ids" toon:"added_assignee_ids"`
	// True when the call replayed an earlier request with the same idempotency key.
	IdempotentReplay bool         `json:"idempotent_replay" toon:"idempotent_replay"`
	Item             WorkItemItem `json:"item" toon:"item"`
	// Assignee member IDs that were removed (never notified).
	RemovedAssigneeIDs []int64 `json:"removed_assignee_ids" toon:"removed_assignee_ids"`
}

WorkItemMutationResult is generated from the Flashduty OpenAPI schema.

Source Files

View all Source files

Directories

Path Synopsis
Package e2e contains live end-to-end tests for the Flashduty SDK.
 Package e2e contains live end-to-end tests for the Flashduty SDK.
internal
cmd/gen command
Command gen generates the typed Flashduty service layer and models from the vendored OpenAPI specification (openapi/openapi.en.json).
 Command gen generates the typed Flashduty service layer and models from the vendored OpenAPI specification (openapi/openapi.en.json).
Package retry provides a safe-by-default retrying http.RoundTripper for the Flashduty SDK, usable as a composable transport middleware.
 Package retry provides a safe-by-default retrying http.RoundTripper for the Flashduty SDK, usable as a composable transport middleware.

Jump to

Keyboard shortcuts

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