requestflag

type DateTimeValue string

type DateValue string

type Flag[
	T []any | []map[string]any | []DateTimeValue | []DateValue | []TimeValue | []string |
		[]float64 | []int64 | []bool | any | map[string]any | DateTimeValue | DateValue | TimeValue |
		string | float64 | int64 | bool |
		*string | *float64 | *int64 | *bool | *DateTimeValue | *DateValue | *TimeValue,
] struct {
	Name        string               // name of the flag
	Category    string               // category of the flag, if any
	DefaultText string               // default text of the flag for usage purposes
	HideDefault bool                 // whether to hide the default value in output
	Usage       string               // usage string for help output
	Sources     cli.ValueSourceChain // sources to load flag value from
	Required    bool                 // whether the flag is required or not
	Hidden      bool                 // whether to hide the flag in help output
	Default     T                    // default value for this flag if not set by from any source
	Aliases     []string             // aliases that are allowed for this flag
	Validator   func(T) error        // custom function to validate this flag value

	QueryPath  string // location in the request query string to put this flag's value
	HeaderPath string // location in the request header to put this flag's value
	BodyPath   string // location in the request body to put this flag's value
	BodyRoot   bool   // if true, then use this value as the entire request body
	PathParam  string // name of the URL path parameter this flag's value maps to

	// Const, when true, marks this flag as a constant. The flag's Default value is used as the fixed value
	// and always included in the request (IsSet returns true). The user can still see and override the flag,
	// but isn't required to provide it. This is used for single-value enums and `x-stainless-const`
	// parameters.
	Const bool

	// FileInput, when true, indicates that the flag value is always treated as a file path. The file is read
	// automatically without requiring the "@" prefix. This is used for parameters with `type: string, format:
	// binary` in the OpenAPI spec.
	FileInput bool

	// DataAliases is a list of alternate names for this parameter recognized when parsing piped YAML/JSON
	// input. Values keyed by any alias are translated to the canonical API name before being sent.
	DataAliases []string
	// contains filtered or unexported fields
}

type HasOuterFlag interface {
	cli.Flag
	SetOuterFlag(cli.Flag)
	GetOuterFlag() cli.Flag
	GetInnerField() string
	GetDataAliases() []string
}

type InRequest interface {
	GetQueryPath() string
	GetHeaderPath() string
	GetBodyPath() string
	GetPathParam() string
	IsBodyRoot() bool
	IsFileInput() bool
	GetDataAliases() []string
}

type InnerFieldSeeder interface {
	SeedInnerCollection(isArrayOfObjects bool)
}

type InnerFlag[
	T []any | []map[string]any | []DateTimeValue | []DateValue | []TimeValue | []string |
		[]float64 | []int64 | []bool | any | map[string]any | DateTimeValue | DateValue | TimeValue |
		string | float64 | int64 | bool |
		*string | *float64 | *int64 | *bool | *DateTimeValue | *DateValue | *TimeValue,
] struct {
	Name        string        // name of the flag
	DefaultText string        // default text of the flag for usage purposes
	Usage       string        // usage string for help output
	Aliases     []string      // aliases that are allowed for this flag
	Validator   func(T) error // custom function to validate this flag value

	OuterFlag   cli.Flag // The flag on which this inner flag will set values
	InnerField  string   // The inner field which this flag will set
	DataAliases []string // alternate names recognized in YAML values passed as the outer flag

	// OuterIsArrayOfObjects tells an untyped outer flag (Flag[any], used for nullable
	// complex schemas) to seed its underlying value as []map[string]any rather than
	// map[string]any before SetInnerField runs. The hint is ignored for typed outer
	// flags whose zero value already carries a dispatchable reflect.Kind.
	OuterIsArrayOfObjects bool
}

type RequestContents struct {
	Queries map[string]any
	Headers map[string]any
	Body    any
}

type RequiredFlagOrStdin interface {
	IsRequiredAsFlagOrStdin() bool
}

type SettableInnerField interface {
	SetInnerField(string, any)
}

type TimeValue string