ast

type AST struct {
	ASTVersion string

	// Given that this AST is primarily concerned with producing an AST
	// for the *generated* SDK, there are often cases where we don't want
	// to pollute the resulting AST with lower level OpenAPI document structures.
	// For the docs product where we produce a "view model" AST, we still need to
	// access these underlying constructs so we embed the OpenAPI document here.
	OpenAPIDocument *openapi.OpenAPI
	MainSDK         *SDK
	Webhooks        *sequencedmap.Map[string, []Operation]
	// Arazzo contains test-generation workflow graph data derived from
	// x-speakeasy-test Arazzo documents.
	Arazzo           *Arazzo
	Tests            *Tests
	Components       *sequencedmap.Map[string, *TypeDef]
	UsedFeatures     map[string]bool
	UsedTypes        map[string]bool
	BucketedTypes    BucketedTypes
	OperationServers *sequencedmap.Map[string, *Servers]
	PublicExports    *PublicExports

	// Terraform Provider as gathered from various x-speakeasy-entity*
	// extensions across the source document. Only set when generation target
	// is "terraform".
	TerraformProvider *TerraformProvider
}

type Annotation interface {
	// Should return a deep copy of the Annotation.
	Clone() Annotation

	// Should return true if the Annotation is equal to the given Annotation.
	IsEqual(a Annotation) bool

	// Should return true if the Annotation is of the same concrete type as the given Annotation.
	IsSameType(a Annotation) bool

	// Should return true if the Annotation is of the given type.
	IsType(t AnnotationType) bool

	// Should return the type of the Annotation.
	Type() AnnotationType
}

type AnnotationType string

type Annotations []Annotation

type AnyValue struct {
	Value any
}

type Arazzo struct {
	// Workflows are reusable workflow definitions keyed by workflow name and used
	// by templates to resolve workflow-step references.
	Workflows []*ArazzoWorkflow
}

type ArazzoInvocationContext struct {
	SDK       *SDK
	Operation *Operation
	StepIdx   int
	StepID    string
}

type ArazzoOperationStep struct {
	ArazzoStepBase

	Invocation *ArazzoInvocationContext
	// The context of the test operation, this is used to provide details for things such as security, server_url etc
	UsageContext *UsageContext
	// Operation and StepIdx are transitional compatibility fields while consumers migrate to Invocation.
	// Prefer Invocation.Operation and Invocation.StepIdx in new code.
	Operation *Operation
	// StepIdx is the original index of this step in the source Arazzo workflow.
	//
	// Two different operation step nodes can reference the same operation but
	// have different StepIdx values based on which step in the workflow they are in.
	StepIdx int
	// Security is an example of the security that should be used for the operation
	Security *Example
	// ResponseContentType is the content type of the response that should be used for the operation
	ResponseContentType string
}

type ArazzoStep interface {
	GetType() ArazzoStepType
	GetStepID() string
}

type ArazzoStepBase struct {
	Type string
	// StepID is the ID of the step in an Arazzo workflow that this step is in
	StepID string
}

type ArazzoStepType string

type ArazzoWorkflow struct {
	Name        string
	Description string
	Server      string
	Security    *Example
	Steps       []ArazzoStep
	Inputs      *FieldDef
	Outputs     *FieldDef
}

type ArazzoWorkflowStep struct {
	ArazzoStepBase

	// StepIdx is the original index of this step in the source Arazzo workflow.
	//
	// This must be used for example-name reconstruction because generated AST
	// step slices can omit unsupported steps (for example webhooks), which would
	// otherwise skew index-based lookups.
	StepIdx int
	// WorkflowID references the invoked workflow definition by name.
	WorkflowID string
	// Workflow is the resolved workflow definition when available.
	Workflow *ArazzoWorkflow
}

type Arguments struct {
	// Flattening is the strategy used to flatten the request into a list of
	// SDK method arguments.
	// - "none": no flattening is applied. Sorted _may_ contain up to two fields
	//   representing the request and security inputs.
	//
	// - "all": parameters and request body fields have been exploded into the
	//   Sorted list. This implies that an operation contains both parameters
	//   _and_ a body. Security field may also be included depending on
	//   per-operation security requirements.
	//
	// - "params": parameters have been exploded into the Sorted and there may
	//   be a single field representing the request body if an operation has a
	//   body. Security field may also be included depending on per-operation
	//   security requirements.
	//
	// - "body": request body has been exploded into the Sorted list. This also
	//   means that the operation does not have parameters. Security field may
	//   also be included depending on per-operation security requirements.
	Flattening string `yaml:",omitempty"` // "none", "all", "body", "params"

	// Sorted is a list of the arguments to template in SDK methods. It includes
	// per-operation security, request parameters, and request body fields
	// depending on the flattening strategy. The ordering of fields is based
	// on a combination of criteria such as optionality and whether a field
	// represents additional properties.
	Sorted Fields `yaml:",omitempty"`

	// ParamFields is the subset of fields in Sorted that contains all request
	// parameters if the request is flattened. This will be an empty slice if
	// there are no parameters or the request is not flattened.
	ParamFields Fields `yaml:",omitempty"`

	// BodyFields is the subset of fields in Sorted that contains all request
	// body fields if the body is flattened. This will be an empty slice if the
	// body is not flattened.
	//
	// NOTE: This field is mutually exclusive with `BodyField`. Only one of them
	// is populated based on the flattening strategy.
	BodyFields Fields `yaml:",omitempty"`

	// BodyField is set when the request body is flattened. It is used to
	// determine how to reconstruct the request model.
	//
	// NOTE: This field is mutually exclusive with `BodyFields`. Only one of
	// them is populated based on the flattening strategy.
	BodyField *FieldDef `yaml:",omitempty"`

	Warning error `yaml:",omitempty"`
}

type ArgumentsOptions struct {
	// ParamFlatteningBodyFirst affects whether param fields come before the
	// request body field or the other way around.
	ParamFlatteningParamsFirst bool

	// MaxMethodParams is the maximum number of parameters that a method can
	// have and still be eligible for parameter flattening.
	MaxMethodParams int

	// FlattenRequest indicates if request body fields should be flattened.
	FlattenRequest bool

	// In many languages, for convenience we don't render const fields in
	// models / arguments because we just go ahead and fill it in
	// In Typescript, due to structural typing this can cause issues in unions
	ConstFieldsAlwaysOptional *bool
}

type Assertion struct {
	// Type of assertion, such as the operator in a condition.
	Type AssertionType

	// Target type of the assertion, such as status code or response body.
	TargetType AssertionTarget

	// Target of the assertion, such as the computed FieldDef.
	Target any

	// Value to assert against.
	Value any
}

type AssertionTarget string

type AssertionType string

type Assertions []*Assertion

type BaseOperation struct {
	ID                        string               `yaml:",omitempty"` // The unique ID of the operation
	OriginalID                string               `yaml:",omitempty"` // The original ID of the operation this won't be mutated by having multiple request bodies for example
	Request                   *Request             `yaml:",omitempty"` // The request of the operation
	Response                  *Response            `yaml:",omitempty"` // The response of the operation
	UsesUserAgentHeader       bool                 `yaml:",omitempty"` // Whether the operation uses the User-Agent header
	SerializationMethod       *SerializationMethod `yaml:",omitempty"` // The serialization method for the operation
	SerializationMethodSuffix string               `yaml:",omitempty"` // The serialization method suffix for the operation if its been split into multiple methods
}

type BucketedTypes = *sequencedmap.Map[string, *sequencedmap.Map[string, TypeDefs]]

type Comment struct {
	Summary                string                      `yaml:",omitempty"`
	Description            string                      `yaml:",omitempty"`
	ExternalDocs           *ExternalDocs               `yaml:",omitempty"`
	ExtendedComments       map[string]*ExtendedComment `yaml:",omitempty"`
	Deprecated             bool                        `yaml:",omitempty"`
	DeprecationReplacement string                      `yaml:",omitempty"`
	DeprecationMessage     string                      `yaml:",omitempty"`
}

type ContextFrame struct {
	Type                ContextType `yaml:",omitempty"` // The Type of the context which represents things like whether it came from a request or response etc
	Identifier          string      `yaml:",omitempty"` // The identifier of the context, e.g. the operation id or parent schema ref
	IdentifierForNaming *string     `yaml:",omitempty"` // The humanized identifier of the context, e.g. the operation id or parent schema ref
	Used                bool        `yaml:",omitempty"` // Whether or not the context has been used for renaming
	MustUse             bool        `yaml:",omitempty"` // Deprecated: Whether or not the context must be used for renaming
}

type ContextStack []ContextFrame

type ContextStacks []ContextStack

type ContextType string

type DataType string

type Discriminator struct {
	TypePropertyName string                `yaml:",omitempty"`
	Mapping          DiscriminatorMappings `yaml:",omitempty"`
	Inferred         bool                  `yaml:",omitempty"`
}

type DiscriminatorMapping struct {
	Name        string   `yaml:",omitempty"`
	DisplayName string   `yaml:",omitempty"`
	Type        *TypeDef `yaml:",omitempty"`
}

type DiscriminatorMappings []*DiscriminatorMapping

type EncodingAnnotation struct {
	MediaType string `yaml:",omitempty"`
}

type Enum struct {
	Type         *TypeDef          `yaml:",omitempty"`
	Values       []string          `yaml:",omitempty"`
	Names        []string          `yaml:",omitempty"`
	Open         bool              `yaml:",omitempty"`
	Format       string            `yaml:",omitempty"` // Whether the enum is templated as a native enum or union of literals. If empty use language default
	Descriptions map[string]string `yaml:",omitempty"`
}

type Example struct {

	// Description is the description of the example
	Description string

	// Value is the example value if set otherwise it is a reference to another field
	Value *yaml.Node
	// Reference is a reference to another field in another operation if set
	Reference *ExampleReference

	// Replacements are replacements for fields in the example or reference
	Replacements []*ExampleReplacement
	// contains filtered or unexported fields
}

type ExampleReference struct {
	// Target can be one of a number of different target types like ResponseBodyTarget, InputTarget or OutputTarget
	Target any
	// The type of the Target to help determine its typing
	Type string
}

type ExampleReplacement struct {
	// Path is a json-pointer to the field in the example
	Path string
	// Value is the replacement for the field
	Value *Example
}

type Examples []*Example

type ExtendedComment struct {
	Summary     string `yaml:",omitempty"`
	Description string `yaml:",omitempty"`
}

type ExternalDocs struct {
	Description string `yaml:",omitempty"`
	URL         string `yaml:",omitempty"`
}

type FieldAddOptions struct {
	MaintainOriginalOrder bool
	Sanitize              bool
}

type FieldDef struct {
	Name                   string               `yaml:",omitempty"` // The name of the field within the class
	OriginalName           string               `yaml:",omitempty"` // The name of a field as it appears in the source document if it was a property in an object schema
	Type                   *TypeDef             `yaml:",omitempty"` // The type of the field
	Comments               *Comment             `yaml:",omitempty"` // The comments associated with the field
	Annotations            Annotations          `yaml:",omitempty"` // Any annotations applied to the field
	Nullable               bool                 `yaml:",omitempty"` // Whether the field is nullable
	Optional               bool                 `yaml:",omitempty"` // In the case of an object property, indicates whether the field is non-required. Otherwise, matches Nullable
	SerializationMethod    *SerializationMethod `yaml:",omitempty"` // The serialization method to use for the field if any
	ErrorMessage           bool                 `yaml:",omitempty"` // Whether or not the field is an error message when used in an error type
	Const                  *AnyValue            `yaml:",omitempty"` // The constant value of the field if any
	Default                *AnyValue            `yaml:",omitempty"` // The default value of the field if any
	IsAdditionalProperties bool                 `yaml:",omitempty"` // Whether or not the field is an additional properties field
	IsResponseHeaders      bool                 `yaml:",omitempty"` // Whether or not the field is the response headers field
	IsResponseMetadata     bool                 `yaml:",omitempty"` // Whether or not the field is HTTP response metadata (ContentType/StatusCode/RawResponse)
	ParameterIndex         *int                 `yaml:",omitempty"` // The index of the parameter in the operation if the field is a request parameter
}

type Fields []*FieldDef

type FormAnnotation struct {
	Name      string   `yaml:",omitempty"`
	JSON      bool     `yaml:",omitempty"`
	Style     string   `yaml:",omitempty"`
	Explode   bool     `yaml:",omitempty"`
	FieldType *TypeDef `yaml:",omitempty"`
}

type HoistedSecurityConfig struct {
	// Equivalent is true when the operation's security requirements functionally match
	// global security (identical schemes, same OR-order, and matching optionality).
	// When false, templates must filter global security fields using Fields.
	Equivalent bool
	// Fields maps operation-level security requirements to their corresponding global security
	// fields, ordered according to the operation-level security definition.
	Fields []HoistedSecurityField
}

type HoistedSecurityField struct {
	// The global security field name corresponding to the hoisted security requirement
	Name string `yaml:",omitempty"`
	// The position of the hoisted field in the global security field slice
	Index int `yaml:",omitempty"`
	// The index of the requirement group, used to identify composite requirements (AND).
	// For flattened schemes (e.g. Username/Password): Group will always be 0.
	// For simple OR configurations (unflattened): Index and Group will match.
	Group int `yaml:",omitempty"`
}

type InputTarget struct {
	// Target is the target FieldDef or TypeDef that the reference is pointing to
	Target any
	// Path is a json-pointer to the field in the inputs
	Path string
	// The inputs content that the reference is pointing to
	Inputs *FieldDef
}

type IsEqualOpt func(opts *isEqualOpts)

type JSONAnnotation struct {
	Ignore    bool   `yaml:",omitempty"`
	FieldName string `yaml:",omitempty"`
}

type Matchers struct {
	SDK                  func(*SDK) error
	Servers              func(*Servers) error
	Server               func(*Server) error
	ServerVariable       func(*ServerVariable) error
	FieldDef             func(*FieldDef) error
	Annotations          func(Annotations) error
	TypeDef              func(*TypeDef) error
	ContextStack         func(ContextStack) error
	Validations          func(*Validations) error
	Enum                 func(*Enum) error
	Discriminator        func(*Discriminator) error
	DiscriminatorMapping func(*DiscriminatorMapping) error
	Examples             func(Examples) error
	Operation            func(*Operation) error
	Request              func(*Request) error
	RequestParams        func(*RequestParams) error
	Param                func(*Param) error
	Response             func(*Response) error
	SubResponse          func(*SubResponse) error
	ResponseBodyContent  func(*ResponseBodyContent) error
	OperationExtensions  func(*OperationExtensions) error
	TypeDefExtensions    func(*TypeDefExtensions) error
	Arguments            func(*Arguments) error
	Comment              func(*Comment) error
	ExtendedComment      func(*ExtendedComment) error
	ExternalDocs         func(*ExternalDocs) error
}

type MultipartFormAnnotation struct {
	File      bool     `yaml:",omitempty"`
	Content   bool     `yaml:",omitempty"`
	JSON      bool     `yaml:",omitempty"`
	Name      string   `yaml:",omitempty"`
	FieldType *TypeDef `yaml:",omitempty"`
}

type NeedsCasingAnnotation struct{}

type Node interface {
	Match(Matchers) error
}

type NodeType string

type OAuth2Config map[string]OAuth2FlowConfig

type OAuth2Flow string

type OAuth2FlowConfig struct {
	Flow            OAuth2Flow
	Enabled         bool
	Comments        Comment
	RequiredScopes  []string
	AvailableScopes []OAuth2Scope
}

type OAuth2Scope struct {
	Name     string
	Comments Comment
}

type OpenAPILocation struct {
	Node *yaml.Node
}

type Operation struct {
	BaseOperation
	Path                   string                 `yaml:",omitempty"` // The API path the operation is associated with
	Method                 string                 `yaml:",omitempty"` // The HTTP method the operation uses
	Security               *FieldDef              `yaml:",omitempty"` // The security definition for the operation (if any)
	GlobalSecurity         *FieldDef              `yaml:",omitempty"` // The global security definition for the SDK (if any)
	HoistedSecurityConfig  *HoistedSecurityConfig `yaml:",omitempty"` // Only set if the operation security was hoisted to the global level
	OAuth2Config           *OAuth2Config          `yaml:",omitempty"` // The operation-specific OAuth2 configuration override
	Scope                  Scope                  `yaml:",omitempty"` // The scope of the operation
	Servers                *Servers               `yaml:",omitempty"` // The list of servers that are specific to the operation
	Comments               *Comment               `yaml:",omitempty"` // The comments associated with the operation
	Tags                   []string               `yaml:",omitempty"` // The OpenAPI tags associated with the operation
	UsesUserAgentHeader    bool                   `yaml:",omitempty"` // Whether the operation uses the User-Agent header
	Callbacks              []*TypeDef             `yaml:",omitempty"` // The list of callbacks associated with the operation
	OwningSDK              *SDK                   `yaml:"-"`          // The SDK that owns the operation
	Extensions             *OperationExtensions   `yaml:",omitempty"` // The extensions associated with the operation
	Globals                *TypeDef               `yaml:",omitempty"` // The global variables associated with the operation
	MaxMethodParams        int                    `yaml:",omitempty"` // The maximum number of parameters the method can have
	Arguments              *Arguments             `yaml:",omitempty"` // The method arguments which include parameters and request body fields
	TestExplicitlyDisabled bool                   `yaml:",omitempty"` // Whether the test configuration was explicitly disabled
	Webhook                *Webhook               `yaml:",omitempty"` // Whether the operation is a webhook
	Location               *OpenAPILocation       `yaml:"-"`          // The location of the operation in the OpenAPI document
	// contains filtered or unexported fields
}

type OperationExtensions struct {
	MethodNameOverride        string                                `yaml:",omitempty"`
	UsageExample              *extensions.UsageExampleConfig        `yaml:",omitempty"`
	Retries                   *extensions.Retries                   `yaml:",omitempty"`
	Timeout                   *int64                                `yaml:",omitempty"`
	Pagination                *extensions.Pagination                `yaml:",omitempty"`
	DocsRateLimits            []extensions.RateLimit                `yaml:",omitempty"`
	ReactHook                 *extensions.ReactHook                 `yaml:",omitempty"`
	MCP                       *extensions.MCP                       `yaml:",omitempty"`
	SSEOverload               *extensions.SSEOverloadConfig         `yaml:",omitempty"`
	PublicExports             []extensions.PublicExport             `yaml:",omitempty"`
	GoOptionalMethodArguments *extensions.GoOptionalMethodArguments `yaml:",omitempty"`
	All                       map[string]any                        `yaml:",omitempty"`

	// Describes x-speakeasy-entity-operation extension configuration. The extension
	// is typically configured along with the x-speakeasy-entity extension to build
	// a single model to describe an API entity. That model is used to describe a
	// Terraform data or managed resource currently, but may represent other target
	// entities in the future.
	//
	// This extension accepts the following data types:
	//
	// - String: A value in the form of Entity#OpType[,OpType...][#Order].
	//   Entity is the name of the entity, OpType is the set of entity operation
	//   types (typically entity lifecycle operations such as "create", "read",
	//   "update", and "delete"), and Order is an optional integer greater than 0
	//   that specifies the order of the operation compared to other definitions of
	//   x-speakeasy-entity-operation with the same Entity#OpType.
	// - Array of string: Multiple values of the above string form when a single API
	//   operation is necessary across multiple entities, such as ["Entity#OpType",
	//   "Entity2#OpType"].
	// - Object: Target-specific configuration for the entity operation, where the
	//   properties are target-defined entity sub-types. This is typically used to
	//   disable automatically generated entity sub-types, should the target create
	//   multiple entity sub-types for the same entity operation, or other advanced
	//   configuration of individual entity sub-types. For example, the Terraform
	//   target automatically generates both a data and managed resource for each
	//   Entity#read associated with another Entity#create, so the object form can
	//   be used to disable data resource generation by specifying
	//   {"terraform-datasource": null, "terraform-resource": "Entity#read"}. Each
	//   property value accepts the above string and array of string forms.
	//   The supported properties are:
	//     - "terraform-datasource": Explicit configuration for Terraform target
	//       data resources.
	//     - "terraform-resource": Explicit configuration for Terraform target
	//       managed resources.
	//
	//
	// Only one of the EntityOperation (x-speakeasy-entity-operation) or
	// EntityOperations (x-speakeasy-entity-operations) extensions is valid in a
	// single API operation.
	EntityOperation *extensions.EntityOperationV1 `yaml:",omitempty"`

	// Describes polling configuration, derived from the x-speakeasy-polling
	// extension configuration. This configuration enables targets implementing
	// the operationPolling generator feature to template operation polling
	// logic for consumer opt-in (or in the case of the terraform target,
	// implement via x-speakeasy-entity-operation).
	Polling *Polling `yaml:",omitempty"`

	// Describes HTTP status codes that indicate an entity is missing/deleted.
	// Derived from the x-speakeasy-entity-missing-codes extension. Used by the
	// Terraform target to call RemoveResource() during Read operations when the
	// API returns one of these status codes.
	EntityMissingCodes extensions.EntityMissingCodes `yaml:",omitempty"`
}

type OperationSecurityAnnotation struct{}

type OutputTarget struct {
	// Target is the target FieldDef or TypeDef that the reference is pointing to
	Target any
	// Path is a json-pointer to the field in the outputs
	Path string
	// The outputs content that the reference is pointing to
	Outputs *FieldDef
	// The index of the step and therefore the operation in the workflow that the reference is pointing to
	StepIdx int
}

type Param struct {
	Field           *FieldDef `yaml:",omitempty"` // The field that the parameter is associated with
	Examples        Examples  `yaml:",omitempty"` // The named examples available for the parameter
	Hidden          bool      `yaml:",omitempty"` // Whether the parameter is hidden as it is only accepted as a global parameter
	AllowEmptyValue bool      `yaml:",omitempty"` // Whether to send the parameter with an empty value in the query string (e.g., "?param=")
}

type ParamAnnotation struct {
	ParamType     string   `yaml:",omitempty"`
	Name          string   `yaml:",omitempty"`
	Serialization string   `yaml:",omitempty"`
	Style         string   `yaml:",omitempty"`
	Explode       bool     `yaml:",omitempty"`
	FieldType     *TypeDef `yaml:",omitempty"`
	AllowReserved bool     `yaml:",omitempty"`

	// Enabled when the parameter is global parameter
	IsGlobal bool `yaml:",omitempty"`
	// Contains the operations this parameter is used in if IsGlobal is true
	OperationsForGlobal []string `yaml:",omitempty"`

	// Enabled when the parameter is local to an operation but has a global representation
	HasGlobal bool `yaml:",omitempty"`

	// Enabled when the parameter should be hidden, where the value should not
	// be settable from an operation and only at the SDK level. Hidden is only set
	// if the parameter is global and the x-speakeasy-globals-hidden extension
	// is enabled.
	Hidden bool `yaml:",omitempty"`

	// Enabled when the parameter is global and the path or operation marks it
	// as required. Global parameters are implicitly marked as optional, so this
	// captures the overriding value requirement.
	RequiredForOperation bool `yaml:",omitempty"`
}

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

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 Assertions `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 Assertions `json:"successCriteria,omitempty" yaml:"successCriteria,omitempty"`
}

type PollingOptions []*PollingOption

type PublicExportAmbientExport = publicExportAmbientExport

type PublicExportAmbientRoot = publicExportAmbientRoot

type PublicExportChild struct {
	Name  string   `yaml:",omitempty"`
	Group string   `yaml:",omitempty"`
	Parts []string `yaml:",omitempty"`
}

type PublicExportChildren []*PublicExportChild

type PublicExportGroup struct {
	Group    string               `yaml:",omitempty"`
	Parts    []string             `yaml:",omitempty"`
	Exports  PublicExportTargets  `yaml:",omitempty"`
	Children PublicExportChildren `yaml:",omitempty"`
}

type PublicExportGroups []*PublicExportGroup

type PublicExportTarget struct {
	Name   string   `yaml:",omitempty"`
	Target *TypeDef `yaml:",omitempty"`
	// Input marks exports that alias the target's input-side representation
	// (e.g. the Python TypedDict companion) instead of the model class.
	Input bool `yaml:",omitempty"`
	// Implicit marks exports registered from x-speakeasy-model-namespace
	// tagging rather than an explicit x-speakeasy-exports declaration.
	// Languages only render implicit exports when the SDK opts in via the
	// imports.paths.resources configuration.
	Implicit bool `yaml:",omitempty"`
}

type PublicExportTargets []*PublicExportTarget

type PublicExports struct {
	RootChildren PublicExportChildren `yaml:",omitempty"`
	Groups       PublicExportGroups   `yaml:",omitempty"`
}

type RegistrationIDOption func(opts *RegistrationIDOptions)

type RegistrationIDOptions struct {
	SkipDuplicateFrame   bool
	SkipInputOutputFrame bool
}

type Request struct {
	Field                 *FieldDef      `yaml:",omitempty"` // The field representing the entire request object
	RequestBody           *FieldDef      `yaml:",omitempty"` // The request body field
	MatchedContentTypes   []string       `yaml:",omitempty"` // The content types that were matched and flattened into this request body
	IsRequestBody         bool           `yaml:",omitempty"` // Whether the request is the same as the request body after flattening
	IsRequestBodyRequired bool           `yaml:",omitempty"` // Whether the request is required
	Params                *RequestParams `yaml:",omitempty"` // The parameters that can be passed to the operation
	Examples              Examples       `yaml:",omitempty"` // The examples of the request
}

type RequestAnnotation struct {
	MediaType string `yaml:",omitempty"`
}

type RequestParams struct {
	QueryParams  []*Param `yaml:",omitempty"`
	PathParams   []*Param `yaml:",omitempty"`
	HeaderParams []*Param `yaml:",omitempty"`
}

type RequestWrapperAnnotation struct{}

type Response struct {
	Type      *TypeDef     // The type of the response object
	Responses SubResponses // The list of possible responses that the operation can return
}

type ResponseAnnotation struct {
	ResultField bool `yaml:",omitempty"`
}

type ResponseBodyAssertion struct {
	Path    string
	Value   *Example
	Content *ResponseBodyContent
}

type ResponseBodyContent struct {
	SerializationMethod string    `yaml:",omitempty"` // The serialization method for the content
	ContentType         string    `yaml:",omitempty"` // The content type of the content
	Content             *FieldDef `yaml:",omitempty"` // The content field returned in the response type
	UsageExample        bool      `yaml:",omitempty"` // Whether or not the content should be used as a usage example
	Examples            Examples  `yaml:",omitempty"` // The examples of the content
	SSESentinel         string    `yaml:",omitempty"`
}

type ResponseBodyTarget struct {
	// Target is the target FieldDef or TypeDef that the reference is pointing to
	Target any
	// Path is a json-pointer to the field in the response body
	Path string
	// The response body content that the reference is pointing to
	Body *ResponseBodyContent
	// The index of the step and therefore the operation in the workflow that the reference is pointing to
	StepIdx int
}

type SDK struct {
	FieldName       string         `yaml:",omitempty"` // The name of the field used to access the SDK
	Type            *TypeDef       `yaml:",omitempty"` // The type definition for the SDK class
	Group           string         `yaml:",omitempty"` // The group that the SDK belongs to
	Servers         *Servers       `yaml:",omitempty"` // The defined list of servers the SDK has available to make requests to
	Comments        *Comment       `yaml:",omitempty"` // The documentation for the SDK
	SubSDKs         SDKs           `yaml:",omitempty"` // The list of sub SDKs that are available, containing operations scoped to a particular tag
	Security        *FieldDef      `yaml:",omitempty"` // The security definition for the SDK (if any and generally only populated for the main SDK)
	SecurityConfig  SecurityConfig `yaml:",omitempty"` // The security options for the SDK
	Operations      []*Operation   `yaml:",omitempty"` // The list of operations that are available to this SDK
	AdditionalTypes []*TypeDef     `yaml:",omitempty"` // A list of additional types that are available to the SDK, these are populated from components in the OpenAPI document that use the x-speakeasy-include extension and aren't already present elsewhere in the tree (generally only populated for the main SDK)
	OutputTests     bool           `yaml:",omitempty"` // Whether or not to output tests for the SDK
	TestGroup       string         `yaml:",omitempty"` // Which group of tests to generate (should match the spec file)
	Globals         *TypeDef       `yaml:",omitempty"` // The global variables that are available to the SDK
}

type SDKs []*SDK

type Scope string

type Security struct {
	// Security represents the field added either to the SDK or an operation representing how its security is configured
	Security *FieldDef
	// Requirements are stored to determine if operation security is a subset of global security.
	Requirements []SecurityRequirement
	// SecurityConfig represents the security configuration options for this security block
	SecurityConfig SecurityConfig
}

type SecurityAnnotation struct {
	FieldName string `yaml:",omitempty"`

	// Security scheme type from the OAS Security Scheme object "type" field.
	// Values include "apiKey", "http", "oauth2", and "openIdConnect".
	SecType string `yaml:",omitempty"`

	// Underlying security type. Usage is dependent on SecType:
	// - apiKey: Location of API key from the OAS Security Scheme object "in"
	//           field. Values include "cookie", "header", and "query".
	// - http: HTTP Authentication scheme from the OAS Security Scheme object
	//         "scheme" field, normalized to lowercase. Values include "basic",
	//         "bearer", and "custom".
	// - oauth2: OAuth2 Flow type from the OAuth Flows object field name,
	//           normalized to lowercase snakecase. Values include
	//           "client_credentials" and "password".
	// - openIdConnect: N/A
	SubType string `yaml:",omitempty"`

	// Option (a.k.a. "OptionWrapper") marks this field as a wrapper struct
	// that groups one or more scheme fields together.
	// Option is false for flat configurations, i.e. when multiple simple
	// schemes are in either a OR or AND group (but not both).
	// Option is set for all fields when the security definition is a
	// combination of OR and AND relationships.
	Option bool `yaml:",omitempty"`

	// Scheme marks this field as a security scheme entry point. True for
	// flattened credential fields, unflattened security classes, and fields
	// inside OptionWrapper structs.
	Scheme bool `yaml:",omitempty"`

	// SecurityOption (a.k.a. "Alternative") marks this field as one of multiple
	// independent OR alternatives for authentication. Set on both OptionWrappers
	// and flattened scheme fields when numSchemes > 1. When false, the field
	// is either the only scheme available or part of an AND group.
	SecurityOption bool `yaml:",omitempty"`

	// Composite marks this field as part of an AND group of security schemes.
	Composite bool `yaml:",omitempty"`

	// SchemeKey represents the key of the security scheme in the security field
	SchemeKey string `yaml:",omitempty"`
}

type SecurityConfig struct {
	// OptionalityReason represents the reason why this security block is optional
	OptionalityReason SecurityOptionalityReason
	// OAuth2Config configures a OAuth2 flow in this security block, used to collect OAuth2Scopes and enable hooks
	OAuth2Config OAuth2Config
	// Disabled indicates whether this security block was explicitly disabled
	Disabled bool
	// HoistedSecurityConfig is populated when the operation security was hoisted to the global level.
	// Nil when the operation defines its own non-matching security or no operation-level security exists.
	HoistedSecurityConfig *HoistedSecurityConfig
}

type SecurityOptionalityReason string

type SecurityRequirement []SecurityScheme

type SecurityScheme string

type SerializationMethod string

type Server struct {
	ID         string            `yaml:",omitempty"` // The ID of the server (if any)
	URL        string            `yaml:",omitempty"` // Server URLs can be templated strings containing braces, e.g. "https://{env}.example.com"
	IsRelative bool              `yaml:",omitempty"` // Whether or not the url is relative
	Comments   *Comment          `yaml:",omitempty"` // The comments associated with the server
	Variables  []*ServerVariable `yaml:",omitempty"` // The variables associated with the url if it is templated
}

type ServerVariable struct {
	Name        string   `yaml:",omitempty"`
	Type        *TypeDef `yaml:",omitempty"`
	Default     string   `yaml:",omitempty"`
	ServerIndex int      `yaml:",omitempty"` // Index of the server this variable belongs to
	Server      *Server  `yaml:",omitempty"` // Reference to the server this variable belongs to
}

type Servers struct {
	Servers   []*Server `yaml:",omitempty"` // The list of servers
	Default   string    `yaml:",omitempty"` // The ID of the default server (if any)
	ServerMap bool      `yaml:",omitempty"` // Whether or not the list of servers should be represented as a map
}

type SubResponse struct {
	Code    []string               // The status code associated with this particular response
	Headers bool                   // Whether or not the response has headers
	Content []*ResponseBodyContent // The content that is returned in the response
	Error   bool                   // Whether or not the response is an error
}

type SubResponses []*SubResponse

type TerraformAction struct {
	// Description for the action. Sourced from
	// x-speakeasy-entity-description configuration, if available.
	Description string `json:"description" yaml:"description"`

	// Mapping of global field names to definitions for all operations. These
	// are added to the entity resource struct type, copied in the Configure()
	// method, made optional in the resource schema, and checked in the resource
	// methods.
	GlobalFields map[string]*FieldDef `json:"globalFields" yaml:"globalFields"`

	// Computed Go type name for the action data model struct, e.g.
	// "ExampleActionModel". Set by NewTerraformAction.
	GoDataModelTypeName string `json:"goDataModelTypeName" yaml:"goDataModelTypeName"`

	// Computed Go type name for the action private data model struct, e.g.
	// "ExampleActionPrivateDataModel". Set by NewTerraformAction.
	GoPrivateDataModelTypeName string `json:"goPrivateDataModelTypeName" yaml:"goPrivateDataModelTypeName"`

	// Computed Go type name for the action struct implementation, e.g.
	// "ExampleAction". Set by NewTerraformAction.
	GoTypeName string `json:"goTypeName" yaml:"goTypeName"`

	// Whether the entity requires SDK method options in its generated code.
	// This is true when any operation has a Patch.Style configuration.
	// Populated by AssembleSchemaTypeDef.
	IncludeSDKMethodOptions bool `json:"includeSDKMethodOptions,omitempty" yaml:"includeSDKMethodOptions,omitempty"`

	// Unsanitized name of the action type, such as "Thing".
	Name string `json:"name" yaml:"name"`

	// Operation security configuration for the action. This is set
	// when the underlying operations have operation security defined and the
	// enableOperationSecurity generation configuration flag is enabled. Only
	// a single operation security configuration is supported per action,
	// even if multiple operations have differing security configurations. This
	// is intentional to simplify the generated Terraform code and avoid
	// complexity around per-operation security configuration for consumers.
	OperationSecurity *FieldDef `json:"operationSecurity" yaml:"operationSecurity"`

	// All operations associated with the action.
	Operations *TerraformActionOperations `json:"operations" yaml:"operations"`

	// Mapping of pagination input field names to an unused boolean value
	// that is replaceable for future updates.
	PaginationInputFields map[string]bool `json:"paginationInputFields" yaml:"paginationInputFields"`

	// Mapping of pagination output field names to an unused boolean value
	// that is replaceable for future updates.
	PaginationOutputFields map[string]bool `json:"paginationOutputFields" yaml:"paginationOutputFields"`

	// Merged Terraform resource schema TypeDef across all operations. This
	// represents the combined schema view of the action after merging all
	// operation shards together.
	SchemaTypeDef *TypeDef `json:"-" yaml:"-"`

	// Deduplicated, sorted list of SDK request conversion methods (To_ prefix)
	// pre-computed from all operations. Populated by AssembleSchemaTypeDef.
	SDKRequestMethods []*TerraformSDKMethod `json:"-" yaml:"-"`

	// Deduplicated, sorted list of SDK response conversion methods
	// (RefreshFrom_ or RefreshFromArrayOf_ prefix) pre-computed from
	// DataModelRefreshOperations. Populated by AssembleSchemaTypeDef.
	SDKResponseMethods []*TerraformSDKMethod `json:"-" yaml:"-"`

	// Server configuration for the action. This is defined when
	// the underlying operations have path or operation server URLs defined.
	// Only a single server configuration is supported per action,
	// even if multiple operations have differing server URLs defined. This is
	// intentional to simplify the generated Terraform code and avoid complexity
	// around per-operation server configuration for consumers.
	Server *TerraformServer `json:"server" yaml:"server"`

	// Resolved full Terraform action type name (e.g.
	// "myprovider_my_action"), composed from the resolved provider type
	// name and the snake_case form of Name. Used as the value of
	// resp.TypeName in the action Metadata implementation and in example
	// Terraform configuration files. Populated by
	// TerraformProvider.AddOrGetAction.
	TerraformTypeName string `json:"terraformTypeName" yaml:"terraformTypeName"`
}

type TerraformActionOperations struct {
	// Ordered invoke operations. Populated by MergeOperationShards.
	Invoke TerraformOperations `json:"-" yaml:"-"`

	// Merged request shard across all invoke operations. Populated by
	// MergeOperationShards.
	InvokeRequestShard *TypeDef `json:"-" yaml:"-"`

	// Merged response shard across all invoke operations. Populated by
	// MergeOperationShards.
	InvokeResponseShard *TypeDef `json:"-" yaml:"-"`

	// Merged request and response shard across all invoke operations.
	// Populated by MergeOperationShards.
	InvokeShard *TypeDef `json:"-" yaml:"-"`
	// contains filtered or unexported fields
}

type TerraformDataResource struct {
	// Description for the data resource. Sourced from
	// x-speakeasy-entity-description configuration, if available.
	Description string `json:"description" yaml:"description"`

	// Mapping of global field names to definitions for all operations. These
	// are added to the entity resource struct type, copied in the Configure()
	// method, made optional in the resource schema, and checked in the resource
	// methods.
	GlobalFields map[string]*FieldDef `json:"globalFields" yaml:"globalFields"`

	// Computed Go type name for the data resource data model struct, e.g.
	// "ExampleDataSourceModel". Set by NewTerraformDataResource.
	GoDataModelTypeName string `json:"goDataModelTypeName" yaml:"goDataModelTypeName"`

	// Computed Go type name for the data resource private data model struct, e.g.
	// "ExampleDataSourcePrivateDataModel". Set by NewTerraformDataResource.
	GoPrivateDataModelTypeName string `json:"goPrivateDataModelTypeName" yaml:"goPrivateDataModelTypeName"`

	// Computed Go type name for the data resource struct implementation, e.g.
	// "ExampleDataSource". Set by NewTerraformDataResource.
	GoTypeName string `json:"goTypeName" yaml:"goTypeName"`

	// Whether the entity requires SDK method options in its generated code.
	// This is true when any operation has a Patch.Style configuration.
	// Populated by AssembleSchemaTypeDef.
	IncludeSDKMethodOptions bool `json:"includeSDKMethodOptions,omitempty" yaml:"includeSDKMethodOptions,omitempty"`

	// Unsanitized name of the data resource type, such as "Thing".
	Name string `json:"name" yaml:"name"`

	// Operation security configuration for the data resource. This is set
	// when the underlying operations have operation security defined and the
	// enableOperationSecurity generation configuration flag is enabled. Only
	// a single operation security configuration is supported per data resource,
	// even if multiple operations have differing security configurations. This
	// is intentional to simplify the generated Terraform code and avoid
	// complexity around per-operation security configuration for consumers.
	OperationSecurity *FieldDef `json:"operationSecurity" yaml:"operationSecurity"`

	// All operations associated with the data resource.
	Operations *TerraformDataResourceOperations `json:"operations" yaml:"operations"`

	// Mapping of pagination input field names to an unused boolean value
	// that is replaceable for future updates.
	PaginationInputFields map[string]bool `json:"paginationInputFields" yaml:"paginationInputFields"`

	// Mapping of pagination output field names to an unused boolean value
	// that is replaceable for future updates.
	PaginationOutputFields map[string]bool `json:"paginationOutputFields" yaml:"paginationOutputFields"`

	// Merged Terraform resource schema TypeDef across all operations. This
	// represents the combined schema view of the data resource after merging
	// all operation shards together.
	SchemaTypeDef *TypeDef `json:"-" yaml:"-"`

	// Deduplicated, sorted list of SDK request conversion methods (To_ prefix)
	// pre-computed from all operations. Populated by AssembleSchemaTypeDef.
	SDKRequestMethods []*TerraformSDKMethod `json:"-" yaml:"-"`

	// Deduplicated, sorted list of SDK response conversion methods
	// (RefreshFrom_ or RefreshFromArrayOf_ prefix) pre-computed from
	// DataModelRefreshOperations. Populated by AssembleSchemaTypeDef.
	SDKResponseMethods []*TerraformSDKMethod `json:"-" yaml:"-"`

	// Server configuration for the data resource. This is defined when
	// the underlying operations have path or operation server URLs defined.
	// Only a single server configuration is supported per data resource,
	// even if multiple operations have differing server URLs defined. This is
	// intentional to simplify the generated Terraform code and avoid complexity
	// around per-operation server configuration for consumers.
	Server *TerraformServer `json:"server" yaml:"server"`

	// Resolved full Terraform data source type name (e.g.
	// "myprovider_my_data_source"), composed from the resolved provider type
	// name and the snake_case form of Name. Used as the value of
	// resp.TypeName in the data source Metadata implementation and in
	// example Terraform configuration files. Populated by
	// TerraformProvider.AddOrGetDataResource.
	TerraformTypeName string `json:"terraformTypeName" yaml:"terraformTypeName"`
}

type TerraformDataResourceOperations struct {
	// Ordered read operations. Populated by MergeOperationShards.
	Read TerraformOperations `json:"-" yaml:"-"`

	// Merged request shard across all read operations. Populated by
	// MergeOperationShards.
	ReadRequestShard *TypeDef `json:"-" yaml:"-"`

	// Merged response shard across all read operations. Populated by
	// MergeOperationShards.
	ReadResponseShard *TypeDef `json:"-" yaml:"-"`

	// Merged request and response shard across all read operations.
	// Populated by MergeOperationShards.
	ReadShard *TypeDef `json:"-" yaml:"-"`
	// contains filtered or unexported fields
}

type TerraformEphemeralResource struct {
	// Description for the ephemeral resource. Sourced from
	// x-speakeasy-entity-description configuration, if available.
	Description string `json:"description" yaml:"description"`

	// Mapping of global field names to definitions for all operations. These
	// are added to the entity resource struct type, copied in the Configure()
	// method, made optional in the resource schema, and checked in the resource
	// methods.
	GlobalFields map[string]*FieldDef `json:"globalFields" yaml:"globalFields"`

	// Computed Go type name for the ephemeral resource data model struct, e.g.
	// "ExampleEphemeralResourceModel". Set by NewTerraformEphemeralResource.
	GoDataModelTypeName string `json:"goDataModelTypeName" yaml:"goDataModelTypeName"`

	// Computed Go type name for the ephemeral resource private data model struct,
	// e.g. "ExampleEphemeralResourcePrivateDataModel". Set by
	// NewTerraformEphemeralResource.
	GoPrivateDataModelTypeName string `json:"goPrivateDataModelTypeName" yaml:"goPrivateDataModelTypeName"`

	// Computed Go type name for the ephemeral resource struct implementation, e.g.
	// "ExampleEphemeralResource". Set by NewTerraformEphemeralResource.
	GoTypeName string `json:"goTypeName" yaml:"goTypeName"`

	// Whether the entity requires SDK method options in its generated code.
	// This is always false for ephemeral resources since their operations
	// (open/close) are not checked for SDK method option conditions.
	IncludeSDKMethodOptions bool `json:"includeSDKMethodOptions,omitempty" yaml:"includeSDKMethodOptions,omitempty"`

	// Unsanitized name of the ephemeral resource type, such as "Thing".
	Name string `json:"name" yaml:"name"`

	// Operation security configuration for the ephemeral resource. This is set
	// when the underlying operations have operation security defined and the
	// enableOperationSecurity generation configuration flag is enabled. Only
	// a single operation security configuration is supported per ephemeral resource,
	// even if multiple operations have differing security configurations. This
	// is intentional to simplify the generated Terraform code and avoid
	// complexity around per-operation security configuration for consumers.
	OperationSecurity *FieldDef `json:"operationSecurity" yaml:"operationSecurity"`

	// All operations associated with the ephemeral resource.
	Operations *TerraformEphemeralResourceOperations `json:"operations" yaml:"operations"`

	// Mapping of pagination input field names to an unused boolean value
	// that is replaceable for future updates.
	PaginationInputFields map[string]bool `json:"paginationInputFields" yaml:"paginationInputFields"`

	// Mapping of pagination output field names to an unused boolean value
	// that is replaceable for future updates.
	PaginationOutputFields map[string]bool `json:"paginationOutputFields" yaml:"paginationOutputFields"`

	// Merged Terraform resource schema TypeDef across all operations. This
	// represents the combined schema view of the ephemeral resource after
	// merging all operation shards together.
	SchemaTypeDef *TypeDef `json:"-" yaml:"-"`

	// Deduplicated, sorted list of SDK request conversion methods (To_ prefix)
	// pre-computed from all operations. Populated by AssembleSchemaTypeDef.
	SDKRequestMethods []*TerraformSDKMethod `json:"-" yaml:"-"`

	// Deduplicated, sorted list of SDK response conversion methods
	// (RefreshFrom_ or RefreshFromArrayOf_ prefix) pre-computed from
	// DataModelRefreshOperations. Populated by AssembleSchemaTypeDef.
	SDKResponseMethods []*TerraformSDKMethod `json:"-" yaml:"-"`

	// Server configuration for the ephemeral resource. This is defined when
	// the underlying operations have path or operation server URLs defined.
	// Only a single server configuration is supported per ephemeral resource,
	// even if multiple operations have differing server URLs defined. This is
	// intentional to simplify the generated Terraform code and avoid complexity
	// around per-operation server configuration for consumers.
	Server *TerraformServer `json:"server" yaml:"server"`

	// Resolved full Terraform ephemeral resource type name (e.g.
	// "myprovider_my_ephemeral_resource"), composed from the resolved
	// provider type name and the snake_case form of Name. Used as the value
	// of resp.TypeName in the ephemeral resource Metadata implementation and
	// in example Terraform configuration files. Populated by
	// TerraformProvider.AddOrGetEphemeralResource.
	TerraformTypeName string `json:"terraformTypeName" yaml:"terraformTypeName"`
}

type TerraformEphemeralResourceOperations struct {
	// Ordered close operations. Populated by MergeOperationShards.
	Close TerraformOperations `json:"-" yaml:"-"`

	// Merged request shard across all close operations. Populated by
	// MergeOperationShards.
	CloseRequestShard *TypeDef `json:"-" yaml:"-"`

	// Merged response shard across all close operations. Populated by
	// MergeOperationShards.
	CloseResponseShard *TypeDef `json:"-" yaml:"-"`

	// Merged request and response shard across all close operations.
	// Populated by MergeOperationShards.
	CloseShard *TypeDef `json:"-" yaml:"-"`

	// Ordered open operations. Populated by MergeOperationShards.
	Open TerraformOperations `json:"-" yaml:"-"`

	// Merged request shard across all open operations. Populated by
	// MergeOperationShards.
	OpenRequestShard *TypeDef `json:"-" yaml:"-"`

	// Merged response shard across all open operations. Populated by
	// MergeOperationShards.
	OpenResponseShard *TypeDef `json:"-" yaml:"-"`

	// Merged request and response shard across all open operations.
	// Populated by MergeOperationShards.
	OpenShard *TypeDef `json:"-" yaml:"-"`
	// contains filtered or unexported fields
}

type TerraformHoistedSource struct {
	// AssociatedTypeName is the name of the oneOf associated type containing the source field.
	AssociatedTypeName string `yaml:"associatedTypeName" json:"associatedTypeName"`
	// FieldName is the name of the source field within the associated type.
	FieldName string `yaml:"fieldName" json:"fieldName"`
	// PathPrefix is the path from root to the parent oneOf, used to build absolute paths
	// in plan modifiers. For nested oneOf unions, this contains all intermediate path segments.
	PathPrefix []string `yaml:"pathPrefix,omitempty" json:"pathPrefix,omitempty"`
}

type TerraformInvalidImportType struct {
	// Hierarchy is the dot-separated path to the node within the TypeDef tree.
	Hierarchy string

	// TypeName is the string representation of the unsupported DataType.
	TypeName string
}

type TerraformManagedResource struct {
	// Description for the managed resource. Sourced from
	// x-speakeasy-entity-description configuration, if available.
	Description string `json:"description" yaml:"description"`

	// Mapping of global field names to definitions for all operations. These
	// are added to the entity resource struct type, copied in the Configure()
	// method, made optional in the resource schema, and checked in the resource
	// methods.
	GlobalFields map[string]*FieldDef `json:"globalFields" yaml:"globalFields"`

	// Computed Go type name for the managed resource data model struct, e.g.
	// "ExampleResourceModel". Set by NewTerraformManagedResource.
	GoDataModelTypeName string `json:"goDataModelTypeName" yaml:"goDataModelTypeName"`

	// Computed Go type name for the managed resource private data model struct,
	// e.g. "ExampleResourcePrivateDataModel". Set by NewTerraformManagedResource.
	GoPrivateDataModelTypeName string `json:"goPrivateDataModelTypeName" yaml:"goPrivateDataModelTypeName"`

	// Computed Go type name for the managed resource struct implementation, e.g.
	// "ExampleResource". Set by NewTerraformManagedResource.
	GoTypeName string `json:"goTypeName" yaml:"goTypeName"`

	// Import state TypeDef for the managed resource, derived from the read
	// request shard. Contains only required fields (as determined by
	// FieldDef.IsTerraformImportRequired), sorted alphabetically. Used by
	// Terraform import state template generation to determine the import ID
	// shape. Populated by AssembleSchemaTypeDef.
	ImportStateTypeDef *TypeDef `json:"-" yaml:"-"`

	// Whether the entity requires SDK method options in its generated code.
	// This is true when any operation has a Patch.Style configuration, any
	// update operation has UsePriorState parameters, or any create/update
	// operation has a TerraformWriteOnly extension. Populated by
	// AssembleSchemaTypeDef.
	IncludeSDKMethodOptions bool `json:"includeSDKMethodOptions,omitempty" yaml:"includeSDKMethodOptions,omitempty"`

	// List of HTTP status codes that represent the managed resource is not
	// found in the API during read operations. These codes automatically cause
	// the resource to be removed from the Terraform state rather than return an
	// API error.
	//
	// Defaults to 404, which has historically been used by many APIs to
	// represent this situation. 410 could potentially also be considered in the
	// future. Values can be customized via x-speakeasy-entity-missing-codes
	// extension configuration.
	MissingCodes []int `json:"missingCodes" yaml:"missingCodes"`

	// Name of the managed resource type, such as "examplecloud_thing".
	Name string `json:"name" yaml:"name"`

	// Operation security configuration for the managed resource. This is set
	// when the underlying operations have operation security defined and the
	// enableOperationSecurity generation configuration flag is enabled. Only
	// a single operation security configuration is supported per managed
	// resource, even if multiple operations have differing security
	// configurations. This is intentional to simplify the generated Terraform
	// code and avoid complexity around per-operation security configuration
	// for consumers.
	OperationSecurity *FieldDef `json:"operationSecurity" yaml:"operationSecurity"`

	// All operations associated with the managed resource.
	Operations *TerraformManagedResourceOperations `json:"operations" yaml:"operations"`

	// Mapping of pagination input field names to an unused boolean value
	// that is replaceable for future updates.
	PaginationInputFields map[string]bool `json:"paginationInputFields" yaml:"paginationInputFields"`

	// Mapping of pagination output field names to an unused boolean value
	// that is replaceable for future updates.
	PaginationOutputFields map[string]bool `json:"paginationOutputFields" yaml:"paginationOutputFields"`

	// Fields from the read response shard that have the
	// x-speakeasy-soft-delete-property extension set. These are used to
	// generate soft-delete handling in the resource Read method.
	// Populated by AssembleSchemaTypeDef.
	ReadSoftDeleteProperties Fields `json:"readSoftDeleteProperties,omitempty" yaml:"readSoftDeleteProperties,omitempty"`

	// Terraform schema for the managed resource.
	Schema *TerraformManagedResourceSchema `json:"schema" yaml:"schema"`

	// Merged Terraform resource schema TypeDef across all operations. This
	// represents the combined schema view of the resource after merging all
	// operation shards together.
	SchemaTypeDef *TypeDef `json:"-" yaml:"-"`

	// Warnings collected during schema assembly. These are non-fatal messages
	// (e.g. optional read request field ignoring, update-in-create suggestions)
	// that should be logged after assembly completes.
	SchemaWarnings []string `json:"schemaWarnings,omitempty" yaml:"schemaWarnings,omitempty"`

	// Deduplicated, sorted list of SDK request conversion methods (To_ prefix)
	// pre-computed from all operations. Populated by AssembleSchemaTypeDef.
	SDKRequestMethods []*TerraformSDKMethod `json:"-" yaml:"-"`

	// Deduplicated, sorted list of SDK response conversion methods
	// (RefreshFrom_ or RefreshFromArrayOf_ prefix) pre-computed from
	// DataModelRefreshOperations. Populated by AssembleSchemaTypeDef.
	SDKResponseMethods []*TerraformSDKMethod `json:"-" yaml:"-"`

	// Server configuration for the managed resource. This is defined when
	// the underlying operations have path or operation server URLs defined.
	// Only a single server configuration is supported per managed resource,
	// even if multiple operations have differing server URLs defined. This is
	// intentional to simplify the generated Terraform code and avoid complexity
	// around per-operation server configuration for consumers.
	Server *TerraformServer `json:"server" yaml:"server"`

	// Resolved full Terraform managed resource type name (e.g.
	// "myprovider_my_resource"), composed from the resolved provider type
	// name and the snake_case form of Name. Used as the value of
	// resp.TypeName in the resource Metadata implementation, in example
	// Terraform configuration files, and in import command examples.
	// Populated by TerraformProvider.AddOrGetManagedResource.
	TerraformTypeName string `json:"terraformTypeName" yaml:"terraformTypeName"`
}

type TerraformManagedResourceOperations struct {
	// Ordered create operations. Populated by MergeOperationShards.
	Create TerraformOperations `json:"-" yaml:"-"`

	// CreateNeedsReadAfter indicates whether the read operation should be
	// invoked after create operations because the read response shard
	// contains entity fields not present in the create response shard.
	// Populated by MergeOperationShards.
	CreateNeedsReadAfter bool `json:"-" yaml:"-"`

	// Merged request shard across all create operations. Populated by
	// MergeOperationShards.
	CreateRequestShard *TypeDef `json:"-" yaml:"-"`

	// Merged response shard across all create operations. Populated by
	// MergeOperationShards.
	CreateResponseShard *TypeDef `json:"-" yaml:"-"`

	// Merged request and response shard across all create operations.
	// Populated by MergeOperationShards.
	CreateShard *TypeDef `json:"-" yaml:"-"`

	// Ordered delete operations. Populated by MergeOperationShards.
	Delete TerraformOperations `json:"-" yaml:"-"`

	// Merged request shard across all delete operations. Populated by
	// MergeOperationShards.
	DeleteRequestShard *TypeDef `json:"-" yaml:"-"`

	// Merged response shard across all delete operations. Populated by
	// MergeOperationShards.
	DeleteResponseShard *TypeDef `json:"-" yaml:"-"`

	// Merged request and response shard across all delete operations.
	// Populated by MergeOperationShards.
	DeleteShard *TypeDef `json:"-" yaml:"-"`

	// Ordered read operations. Populated by MergeOperationShards.
	Read TerraformOperations `json:"-" yaml:"-"`

	// Merged request shard across all read operations. Populated by
	// MergeOperationShards.
	ReadRequestShard *TypeDef `json:"-" yaml:"-"`

	// Merged response shard across all read operations. Populated by
	// MergeOperationShards.
	ReadResponseShard *TypeDef `json:"-" yaml:"-"`

	// Merged request and response shard across all read operations.
	// Populated by MergeOperationShards.
	ReadShard *TypeDef `json:"-" yaml:"-"`

	// Ordered update operations. Populated by MergeOperationShards.
	Update TerraformOperations `json:"-" yaml:"-"`

	// UpdateNeedsReadAfter indicates whether the read operation should be
	// invoked after update operations because the read response shard
	// contains entity fields not present in the update response shard.
	// Populated by MergeOperationShards.
	UpdateNeedsReadAfter bool `json:"-" yaml:"-"`

	// Merged request shard across all update operations. Populated by
	// MergeOperationShards.
	UpdateRequestShard *TypeDef `json:"-" yaml:"-"`

	// Merged response shard across all update operations. Populated by
	// MergeOperationShards.
	UpdateResponseShard *TypeDef `json:"-" yaml:"-"`

	// Merged request and response shard across all update operations.
	// Populated by MergeOperationShards.
	UpdateShard *TypeDef `json:"-" yaml:"-"`
	// contains filtered or unexported fields
}

type TerraformManagedResourceSchema struct {
	// Schema version for the managed resource. This relates to Terraform's
	// managed resource state upgrade mechanism. By default and in most cases,
	// this is never set and left as the default value of 0. Sourced from
	// x-speakeasy-entity-version configuration, if available.
	Version int64 `json:"version" yaml:"version"`
}

type TerraformOperation struct {
	// Original API operation. Should always remain untouched.
	APIOperation *Operation

	// EntityMissingCodes holds the HTTP status codes that indicate the entity
	// is not found by the API. Set on read and delete operations for managed
	// resources. The semantics vary by operation type: read operations remove
	// the resource from state (soft delete detection), while delete operations
	// treat these codes as success (the resource is already gone).
	EntityMissingCodes []int

	// Name of the entity this operation is associated with.
	EntityName string

	// String representation from the entity operation configuration in the form
	// of Entity#Op[#Order], such as Thing#create.
	EntityOperation string

	// Has409ConflictCode indicates whether the operation's API response spec
	// defines a 409 Conflict response code. When true, create operations
	// produce "resource already exists" error handling.
	Has409ConflictCode bool

	// IncludeOperationSecurity indicates that this operation has API-level
	// security defined and the entity's enableOperationSecurity generation
	// config flag is enabled. When true, the Terraform resource method
	// invocation includes an operation security variable.
	IncludeOperationSecurity bool

	// Options associated with the entity operation configuration.
	Options *extensions.EntityOperationV1Options

	// Operation request shard. Unset if there is no relevant request.
	//
	// A shard represents the portion of the data that is most relevant to the
	// Terraform resource. For example, the x-speakeasy-entity extension
	// is used to indicate which data represents the top level of the Terraform
	// resource schema, potentially bypassing API-defined intermediate
	// properties such as "data" that are undesirable in Terraform
	// configurations. Resource logic is generated to handle the translation
	// between the API-defined schema and the Terraform resource schema.
	RequestShard *TypeDef

	// RequestBodySDKMethod is the SDK method for the operation's root request
	// type. Matches the target in RequestSDKMethodTargets whose TypeDef
	// equals the request field type. Nil when no matching target exists
	// (e.g. non-class/union request types).
	RequestBodySDKMethod *TerraformSDKMethod

	// RequestSDKMethodTargets holds all SDK TypeDefs that need model-to-SDK
	// (To_) conversion methods for this operation's request. Includes
	// TypeDefs on the path from the request type to the entity TypeDef,
	// plus the root request type itself.
	RequestSDKMethodTargets []TerraformSDKMethodTarget

	// ResponseBodyFieldDef is the response body FieldDef for this operation,
	// resolved by calling TerraformBodyFieldDef(entityName) on the API
	// operation response. Populated by setResponseShard during operation
	// construction. Nil when the response has no body field relevant to the
	// entity or when skipDataModelRefresh is true (cleared by setSDKMethodData).
	// A nil check on this field alone is sufficient to determine whether a
	// data model refresh applies.
	ResponseBodyFieldDef *FieldDef

	// SupportsPagination indicates this operation has a Pagination extension
	// and the response body represents a direct entity (not an array
	// extraction). When true, the Terraform resource method includes
	// pagination loop and pre-refresh field reinitialization logic.
	SupportsPagination bool

	// ResponseBodySDKMethod is the SDK method for the operation's response
	// body type. Matches the target in ResponseSDKMethodTargets whose TypeDef
	// equals ResponseBodyFieldDef.Type. Nil when no matching target or body
	// field exists.
	ResponseBodySDKMethod *TerraformSDKMethod

	// ResponseSDKMethodTargets holds all SDK TypeDefs that need SDK-to-model
	// (RefreshFrom_) conversion methods for this operation's response.
	// Includes the response body type, TypeDefs on the path from the response
	// body to the entity TypeDef, and the entity TypeDef from the full
	// response type. For entity array responses, includes the array wrapper
	// (IsArrayWrapper=true) and item type targets.
	ResponseSDKMethodTargets []TerraformSDKMethodTarget

	// Operation response shard. Unset if there is no relevant response.
	//
	// A shard represents the portion of the data that is most relevant to the
	// Terraform resource. For example, the x-speakeasy-entity extension
	// is used to indicate which data represents the top level of the Terraform
	// resource schema, potentially bypassing API-defined intermediate
	// properties such as "data" that are undesirable in Terraform
	// configurations. Resource logic is generated to handle the translation
	// between the API-defined schema and the Terraform resource schema.
	ResponseShard *TypeDef

	// ServerAttributeName is the Terraform schema attribute name used to look
	// up the per-operation server URL from state. Empty string indicates no
	// server URL support for this operation. The value is derived from
	// entity-level Server configuration during assembly.
	ServerAttributeName string

	// SuccessCodes holds the unique 2xx HTTP status codes defined in the
	// operation's API response spec, used for response validation in
	// Terraform resource methods. Codes containing "X" (e.g. "2XX") are
	// included as-is and matched with a prefix check.
	SuccessCodes []string
	// contains filtered or unexported fields
}