extensions

type BackoffStrategy struct {
	InitialInterval *int     `json:"initialInterval" yaml:"initialInterval,omitempty"`
	MaxInterval     *int     `json:"maxInterval" yaml:"maxInterval,omitempty"`
	Exponent        *float32 `json:"exponent" yaml:"exponent,omitempty"`
	MaxElapsedTime  *int     `json:"maxElapsedTime" yaml:"maxElapsedTime,omitempty"`
}

type Comment struct {
	Summary     string `yaml:"summary" json:"summary"`
	Description string `yaml:"description" json:"description"`
}

type Comments map[string]*Comment

type CoreCustomSecurityConfig struct {
	marshaller.CoreModel `model:"customSecurityConfig"`

	UsesScopes marshaller.Node[*bool]           `key:"usesScopes"`
	Schema     marshaller.Node[core.JSONSchema] `key:"schema" required:"true"`
}

type CoreGlobals struct {
	marshaller.CoreModel `model:"globals"`

	Parameters marshaller.Node[[]marshaller.Node[*core.Reference[*core.Parameter]]] `key:"parameters"`
}

type CustomSecurityConfig struct {
	marshaller.Model[CoreCustomSecurityConfig]

	UsesScopes *bool
	Schema     *oas3.JSONSchema[oas3.Referenceable]
}

type Entity struct {
	// All entity names described by the x-speakeasy-entity extension configuration.
	Names []string `json:"names" yaml:"names"`
}

type EntityDescription struct {
	// Entity description for Terraform action.
	TerraformAction string `json:"terraform_action" yaml:"terraform_action"`

	// Entity description for Terraform data resource.
	TerraformDataResource string `json:"terraform_data_resource" yaml:"terraform_data_resource"`

	// Entity description for Terraform ephemeral resource.
	TerraformEphemeralResource string `json:"terraform_ephemeral_resource" yaml:"terraform_ephemeral_resource"`

	// Entity description for Terraform managed resource.
	TerraformManagedResource string `json:"terraform_managed_resource" yaml:"terraform_managed_resource"`
}

type EntityMissingCodes []int

type EntityOperationV1 struct {
	TerraformActions            []EntityOperationV1Config `json:"terraform_actions" yaml:"terraform_actions"`
	TerraformDataResources      []EntityOperationV1Config `json:"terraform_data_resources" yaml:"terraform_data_resources"`
	TerraformEphemeralResources []EntityOperationV1Config `json:"terraform_ephemeral_resources" yaml:"terraform_ephemeral_resources"`
	TerraformManagedResources   []EntityOperationV1Config `json:"terraform_managed_resources" yaml:"terraform_managed_resources"`
}

type EntityOperationV1Config struct {
	// Name of the entity for this operation.
	Entity string `json:"entity" yaml:"entity"`

	// Types of the entity operation.
	OperationTypes []string `json:"operation_types" yaml:"operation_types"`

	// Optional ordering of the operation compared to other definitions of the
	// same entity and operation type.
	Order *int `json:"order,omitempty" yaml:"order,omitempty"`

	// Optional SDK options for this entity operation.
	Options *EntityOperationV1Options `json:"options,omitempty" yaml:"options,omitempty"`
}

type EntityOperationV1Options struct {
	// Polling configuration for this entity operation.
	Polling *EntityOperationV1Polling `json:"polling,omitempty" yaml:"polling,omitempty"`

	// Patch configuration for update operations.
	Patch *EntityOperationV1Patch `json:"patch,omitempty" yaml:"patch,omitempty"`
}

type EntityOperationV1Patch struct {
	// Style of patch semantics to use for updates.
	// Valid values: "only-send-changed-attributes"
	Style string `json:"style" yaml:"style"`
}

type EntityOperationV1Polling struct {
	// Overrides the number of seconds before the first request.
	DelaySeconds *int `json:"delaySeconds,omitempty" yaml:"delaySeconds,omitempty"`

	// Overrides the number of seconds between requests.
	IntervalSeconds *int `json:"intervalSeconds,omitempty" yaml:"intervalSeconds,omitempty"`

	// Overrides the number of requests to limit polling.
	LimitCount *int `json:"limitCount,omitempty" yaml:"limitCount,omitempty"`

	// Name of the polling option to use.
	Name string `json:"name" yaml:"name"`
}

type EntityVersion struct {
	// Entity version for Terraform managed resource.
	TerraformManagedResource int64 `json:"terraform_managed_resource" yaml:"terraform_managed_resource"`
}

type Errors struct {
	StatusCodes []string `yaml:"statusCodes"`
	Override    bool     `yaml:"override"`
}

type Extension int

type ExtensionScope int

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

type Globals struct {
	marshaller.Model[CoreGlobals]
	Parameters []*openapi.ReferencedParameter
}

type GoOptionalMethodArguments string

type HandleRewriteExtensionOption func(*HandleRewriteExtensionOptions)

type HandleRewriteExtensionOptions struct {
	Extensions OAExtensions
	Node       *yaml.Node
}

type MCP struct {
	Disabled        bool     `json:"disabled" yaml:"disabled"`
	Name            string   `json:"name" yaml:"name"`
	Scopes          []string `json:"scopes" yaml:"scopes"`
	Description     string   `json:"description" yaml:"description"`
	Title           string   `json:"title" yaml:"title"`
	DestructiveHint bool     `json:"destructiveHint" yaml:"destructiveHint"`
	IdempotentHint  bool     `json:"idempotentHint" yaml:"idempotentHint"`
	OpenWorldHint   bool     `json:"openWorldHint" yaml:"openWorldHint"`
	ReadOnlyHint    bool     `json:"readOnlyHint" yaml:"readOnlyHint"`
}

type MatchConfig struct {
	// Path to match in the entity (e.g., "id", "object.id")
	// When specified as a scalar string, this field is populated.
	Path *string `json:"path,omitempty" yaml:"path,omitempty"`

	// Whether to use the prior state value for this parameter in update operations.
	UsePriorState bool `json:"usePriorState,omitempty" yaml:"usePriorState,omitempty"`
}

type NameOverride struct {
	OperationId                 string `json:"operationId" yaml:"operationId"`
	GlobalMethodNameOverride    string `json:"methodNameOverride" yaml:"methodNameOverride"`
	ParameterName               string `json:"parameterName" yaml:"parameterName"`
	GlobalParameterNameOverride string `json:"parameterNameOverride" yaml:"parameterNameOverride"`
	Name                        string
	Node                        *yaml.Node // The yaml node where this extension is defined (for error reporting)
}

type OAExtensions = *extensions.Extensions

type Pagination struct {
	Type    PaginationType     `json:"type" yaml:"type"`
	Inputs  []PaginationInputs `json:"inputs" yaml:"inputs"`
	Outputs PaginationOutputs  `json:"outputs" yaml:"outputs"`
}

type PaginationInputInType string

type PaginationInputType string

type PaginationInputs struct {
	Name     string                `json:"name" yaml:"name"`
	In       PaginationInputInType `json:"in" yaml:"in"`
	Type     PaginationInputType   `json:"type" yaml:"type"`
	Optional bool
}

type PaginationOutputs struct {
	// CanUseDotNotation indicates that the JSONPath expressions in this
	// pagination config are simple enough and it is possible to use a
	// lightweight and more performant object-drilling library instead of a
	// JSONPath library.
	CanUseDotNotation bool `json:"-" yaml:"-"`

	Results    string `json:"results" yaml:"results"`
	ResultsDot string `json:"-" yaml:"-"`

	NumPages    string `json:"numPages" yaml:"numPages"`
	NumPagesDot string `json:"-" yaml:"-"`

	NextCursor    string `json:"nextCursor" yaml:"nextCursor"`
	NextCursorDot string `json:"-" yaml:"-"`

	NextURL    string `json:"nextUrl" yaml:"nextUrl"`
	NextURLDot string `json:"-" yaml:"-"`
}

type PaginationType string

type Polling struct {
	// Collection of polling options.
	Options PollingOptions `json:"options" yaml:"options"`
}

type PollingCriteria []*PollingCriterion

type PollingCriterion struct {
	// Condition for the polling criterion. For simple type criterion, this is
	// typically a full expression such as `$statusCode == 200`. For regex type
	// criterion, this is the regular expression pattern.
	Condition *criterion.Condition `json:"condition,omitempty" yaml:"condition,omitempty"`

	// Context is the expression to the value to be evaluated. Required for
	// regex type criterion.
	Context *expression.Expression `json:"context,omitempty" yaml:"context,omitempty"`

	// Type is the type of criterion. Defaults to CriterionTypeSimple.
	Type criterion.CriterionType `json:"type,omitempty" yaml:"type,omitempty"`
}

type PollingOption struct {
	// Delay in seconds before polling calls begin. Defaults to 1.
	DelaySeconds *int64 `json:"delaySeconds,omitempty" yaml:"delaySeconds,omitempty"`

	// Descibes immediate failure criteria for the polling option. When all
	// matching criteria are met (AND boolean), the operation will immediately
	// return an error.
	FailureCriteria PollingCriteria `json:"failureCriteria,omitempty" yaml:"failureCriteria,omitempty"`

	// Interval between polling calls in seconds. Defaults to 1.
	IntervalSeconds *int64 `json:"intervalSeconds,omitempty" yaml:"intervalSeconds,omitempty"`

	// Name of the polling option.
	Name string `json:"name" yaml:"name"`

	// Number of polling calls not matching the FailureCriteria or
	// SuccessCriteria before returning a timeout error. Defaults to 60.
	LimitCount *int64 `json:"limitCount,omitempty" yaml:"limitCount,omitempty"`

	// Descibes success criteria for the polling option. When all matching
	// criteria are met (AND boolean), the operation will return successfully.
	SuccessCriteria PollingCriteria `json:"successCriteria,omitempty" yaml:"successCriteria,omitempty"`
}

type PollingOptions []*PollingOption

type PublicExport struct {
	Group string `json:"group" yaml:"group"`
	Name  string `json:"name" yaml:"name"`
	// Representation selects the rendering the alias refers to: "model"
	// (default) or "input". See PublicExportRepresentation.
	Representation PublicExportRepresentation `json:"representation,omitempty" yaml:"representation,omitempty"`
}

type PublicExportRepresentation string

type RateLimit struct {
	Strategy      string          `json:"strategy" yaml:"strategy"`
	SlidingWindow *WindowStrategy `json:"sliding_window" yaml:"sliding_window"`
	Identifier    string          `json:"identifier" yaml:"identifier"`
	Description   string          `json:"description" yaml:"description"`
}

type ReactHook struct {
	Disabled bool               `json:"disabled" yaml:"disabled"`
	Name     string             `json:"name" yaml:"name"`
	Type     string             `json:"type" yaml:"type"`
	QueryKey *ReactHookQueryKey `json:"queryKey" yaml:"queryKey"`
}

type ReactHookQueryKey struct {
	IncludeRequestBody bool `json:"includeRequestBody" yaml:"includeRequestBody"`
}

type Retries struct {
	Strategy              string           `json:"strategy" yaml:"strategy,omitempty"`
	DefaultApplied        bool             `json:"defaultApplied,omitempty" yaml:"defaultApplied,omitempty"`
	Disabled              *bool            `json:"disabled,omitempty" yaml:"disabled,omitempty"`
	Backoff               *BackoffStrategy `json:"backoff" yaml:"backoff,omitempty"`
	StatusCodes           []string         `json:"statusCodes" yaml:"statusCodes,omitempty"`
	RetryConnectionErrors *bool            `json:"retryConnectionErrors" yaml:"retryConnectionErrors,omitempty"`
	MaxRetries            *int             `json:"maxRetries" yaml:"maxRetries,omitempty"`
}

type SSEOverloadConfig struct {
	In   string // "body" | "query"
	Name string // resolved field name
}

type SSESentinel struct {
	DataValue string
}

type TerraformCustomDefault struct {
	// Go package imports required for the custom default.
	Imports []string `json:"imports" yaml:"imports"`

	// Code rendered into the schema to instantiate the custom default
	// implementation.
	SchemaDefinition string `json:"schemaDefinition" yaml:"schemaDefinition"`
}

type TerraformIgnore struct {
	// When enabled, the field will be ignored in Terraform data models.
	// Enabled when the ignore extension is set to true.
	DataModel bool `json:"dataModel" yaml:"dataModel"`

	// When enabled, the field will be ignored in Terraform schema definitions.
	// Enabled when the ignore extension is set to true.
	Schema bool `json:"schema" yaml:"schema"`
}

type TransformerConfig struct {
	Type   TransformerType
	Config string
}

type TransformerType string

type UsageExampleConfig struct {
	Title       string   `json:"title" yaml:"title,omitempty"`
	Description string   `json:"description" yaml:"description,omitempty"`
	Position    int      `json:"position" yaml:"position,omitempty"`
	Tags        []string `json:"tags" yaml:"tags,omitempty"`
}

type WebhookSecurity struct {
	// Valid values for this field are:
	//
	// * "signature" a configurable signature which respects header name, text encoding and algorithm
	//
	// * "custom" a custom signature down to the API producer to complete the implementation
	//
	// * "signatureStandardWebhooks" a preset which conforms to "Standard Webhooks" naming / guidance
	//
	// * "apiKey" an API key - no signing is performed
	Type string `json:"type" yaml:"type"`
	// Applicable when Type is "signature"
	HeaderName string `json:"headerName" yaml:"headerName,omitempty"`
	// Applicable when Type is "signature"
	SignatureTextEncoding string `json:"signatureTextEncoding" yaml:"signatureTextEncoding,omitempty"`
	// Applicable when Type is "signature"
	SignatureAlgorithm string `json:"algorithm" yaml:"algorithm,omitempty"`
	// ConsumerShouldProvideSecret is true if the webhook consumer should provide the secret - allows for "custom" type to override the default behavior
	ConsumerShouldProvideSecret *bool `json:"consumerShouldProvideSecret" yaml:"consumerShouldProvideSecret,omitempty"`
}

type Webhooks struct {
	// A WebhookSecurity object is used to configure the security for a webhook.
	Security *WebhookSecurity `json:"security" yaml:"security,omitempty"`
}

type WindowStrategy struct {
	Rate   int    `json:"rate" yaml:"rate"`
	Period string `json:"period" yaml:"period"`
}