api

type APIConnection struct {
	Name    string
	Spec    Spec
	State   *APIState
	Context *g.Context
	// contains filtered or unexported fields
}

type APIState struct {
	Env     map[string]string     `json:"env,omitempty"`
	State   map[string]any        `json:"state,omitempty"`
	Store   map[string]any        `json:"store,omitempty"`
	Inputs  map[string]any        `json:"inputs,omitempty"`
	Secrets map[string]any        `json:"secrets,omitempty"`
	Queues  map[string]*iop.Queue `json:"queues,omitempty"` // appends to file
	Auth    APIStateAuth          `json:"auth,omitempty"`
}

type APIStateAuth struct {
	Authenticated bool              `json:"authenticated,omitempty"`
	Token         string            `json:"token,omitempty"`      // refresh token?
	Headers       map[string]string `json:"-"`                    // to inject
	ExpiresAt     int64             `json:"expires_at,omitempty"` // Unix timestamp when auth expires

	Sign  func(*Iteration, *http.Request, []byte) error `json:"-"`          // for AWS Sigv4, HMAC
	Mutex *sync.Mutex                                   `json:"-" yaml:"-"` // Mutex for auth operations
}

type APIStreamConfig struct {
	Flatten     int // levels of flattening. 0 is infinite
	JmesPath    string
	Select      []string // select specific columns
	PrimaryKey  []string
	Limit       int
	Metadata    iop.Metadata
	Mode        string
	Range       string
	DsConfigMap map[string]any // stream processor options
}

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

type AggregationType string

type AuthType string

type Authentication map[string]any

type Authenticator interface {
	AuthType() AuthType
	Authenticate(ctx context.Context, state *APIStateAuth) error
	Refresh(ctx context.Context, state *APIStateAuth) error
}

type AuthenticatorAWSSigV4 struct {
	AuthenticatorBase
	AwsService         string `yaml:"aws_service,omitempty" json:"aws_service,omitempty"`
	AwsAccessKeyID     string `yaml:"aws_access_key_id,omitempty" json:"aws_access_key_id,omitempty"`
	AwsSecretAccessKey string `yaml:"aws_secret_access_key,omitempty" json:"aws_secret_access_key,omitempty"`
	AwsSessionToken    string `yaml:"aws_session_token,omitempty" json:"aws_session_token,omitempty"`
	AwsRegion          string `yaml:"aws_region,omitempty" json:"aws_region,omitempty"`
	AwsProfile         string `yaml:"aws_profile,omitempty" json:"aws_profile,omitempty"`
}

type AuthenticatorBase struct {
	Type    AuthType `yaml:"type" json:"type"`
	Expires int      `yaml:"expires" json:"expires,omitempty"` // when set, re-auth after number of seconds
	// contains filtered or unexported fields
}

type AuthenticatorBasic struct {
	AuthenticatorBase
	Username string `yaml:"username,omitempty" json:"username,omitempty"`
	Password string `yaml:"password,omitempty" json:"password,omitempty"`
}

type AuthenticatorHMAC struct {
	AuthenticatorBase
	Algorithm     string            `yaml:"algorithm" json:"algorithm"`
	Secret        string            `yaml:"secret" json:"secret"`
	SigningString string            `yaml:"signing_string" json:"signing_string"`
	ReqHeaders    map[string]string `yaml:"request_headers" json:"request_headers"`
	NonceLength   int               `yaml:"nonce_length" json:"nonce_length,omitempty"` // Length of random nonce bytes (0 to disable)
}

type AuthenticatorOAuth2 struct {
	AuthenticatorBase
	ClientID          string    `yaml:"client_id,omitempty" json:"client_id,omitempty"`
	ClientSecret      string    `yaml:"client_secret,omitempty" json:"client_secret,omitempty"`
	RedirectURI       string    `yaml:"redirect_uri,omitempty" json:"redirect_uri,omitempty"`
	AuthenticationURL string    `yaml:"authentication_url,omitempty" json:"authentication_url,omitempty"` // Token endpoint
	AuthorizationURL  string    `yaml:"authorization_url,omitempty" json:"authorization_url,omitempty"`   // Auth endpoint
	DeviceAuthURL     string    `yaml:"device_auth_url,omitempty" json:"device_auth_url,omitempty"`       // Device auth endpoint (optional)
	Scopes            []string  `yaml:"scopes,omitempty" json:"scopes,omitempty"`
	Flow              OAuthFlow `yaml:"flow,omitempty" json:"flow,omitempty"` // e.g., "authorization_code", "client_credentials", "device_code"
}

type AuthenticatorSequence struct {
	AuthenticatorBase
	Sequence Sequence `yaml:"sequence" json:"sequence,omitempty"`
}

type AuthenticatorStatic struct {
	AuthenticatorBase
	Headers map[string]string `yaml:"headers,omitempty" json:"headers,omitempty"`
}

type BackoffType string

type Call struct {
	If             string          `yaml:"if" json:"if"`
	Request        Request         `yaml:"request" json:"request"`
	Pagination     Pagination      `yaml:"pagination" json:"pagination"`
	Response       Response        `yaml:"response" json:"response"`
	Authentication *Authentication `yaml:"authentication,omitempty" json:"authentication,omitempty"`
	Iterate        string          `yaml:"iterate" json:"iterate"`
	Into           string          `yaml:"into" json:"into"`
}

type DynamicEndpoint struct {
	Setup    Sequence `yaml:"setup" json:"setup"`
	Iterate  string   `yaml:"iterate" json:"iterate"`
	Into     string   `yaml:"into" json:"into"`
	Endpoint Endpoint `yaml:"endpoint" json:"endpoint"`
}

type DynamicEndpoints []DynamicEndpoint

type Endpoint struct {
	Name        string     `yaml:"name" json:"name"`
	Description string     `yaml:"description" json:"description,omitempty"`
	Docs        string     `yaml:"docs" json:"docs,omitempty"`
	Disabled    bool       `yaml:"disabled" json:"disabled"`
	Dynamic     bool       `yaml:"dynamic,omitempty" json:"dynamic,omitempty"` // is generated
	State       StateMap   `yaml:"state" json:"state"`
	Sync        []string   `yaml:"sync" json:"sync,omitempty"`
	Request     Request    `yaml:"request" json:"request"`
	Pagination  Pagination `yaml:"pagination" json:"pagination"`
	Response    Response   `yaml:"response" json:"response"`
	Iterate     Iterate    `yaml:"iterate" json:"iterate,omitempty"` // state expression to use to loop
	Setup       Sequence   `yaml:"setup" json:"setup,omitempty"`
	Teardown    Sequence   `yaml:"teardown" json:"teardown,omitempty"`
	DependsOn   []string   `yaml:"depends_on" json:"depends_on"` // upstream endpoints
	Overrides   any        `yaml:"overrides" json:"overrides"`   // stream overrides

	Authentication *Authentication `yaml:"authentication,omitempty" json:"authentication,omitempty"`
	// contains filtered or unexported fields
}

type EndpointMap map[string]Endpoint

type Endpoints []Endpoint

type HTTPMethod string

type Iterate struct {
	Over        any    `yaml:"over" json:"iterate,omitempty"` // expression
	Into        string `yaml:"into" json:"into,omitempty"`    // state variable
	Concurrency int    `yaml:"concurrency" json:"concurrency,omitempty"`
	// contains filtered or unexported fields
}

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

type OAuthFlow string

type Pagination struct {
	NextState     map[string]any `yaml:"next_state" json:"next_state,omitempty"`
	StopCondition string         `yaml:"stop_condition" json:"stop_condition,omitempty"`
}

type Processor struct {
	Aggregation AggregationType `yaml:"aggregation" json:"aggregation"`
	Expression  string          `yaml:"expression" json:"expression"`
	Output      string          `yaml:"output" json:"output"`
	If          string          `yaml:"if" json:"if,omitempty"` // if we should evaluate processor
}

type Records struct {
	JmesPath   string   `yaml:"jmespath" json:"jmespath,omitempty"` // for json or xml
	PrimaryKey []string `yaml:"primary_key" json:"primary_key,omitempty"`
	UpdateKey  string   `yaml:"update_key" json:"update_key,omitempty"`
	Limit      int      `yaml:"limit" json:"limit,omitempty"`   // to limit the records, useful for testing
	Casing     string   `yaml:"casing" json:"casing,omitempty"` // "snake" or "camel"
	Select     []string `yaml:"select" json:"select,omitempty"` // include/exclude/rename

	DuplicateTolerance string `yaml:"duplicate_tolerance" json:"duplicate_tolerance,omitempty"`
}

type Request struct {
	URL         string         `yaml:"url" json:"url,omitempty"`
	Timeout     int            `yaml:"timeout" json:"timeout,omitempty"`
	Method      HTTPMethod     `yaml:"method" json:"method,omitempty"`
	Headers     map[string]any `yaml:"headers" json:"headers,omitempty"`
	Parameters  map[string]any `yaml:"parameters" json:"parameters,omitempty"`
	Payload     any            `yaml:"payload" json:"payload,omitempty"`
	Rate        float64        `yaml:"rate" json:"rate,omitempty"`               // maximum request per second
	Concurrency int            `yaml:"concurrency" json:"concurrency,omitempty"` // maximum concurrent requests
}

type RequestState struct {
	Method   string         `yaml:"method" json:"method"`
	URL      string         `yaml:"url" json:"url"`
	Headers  map[string]any `yaml:"headers" json:"headers"`
	Payload  any            `yaml:"payload" json:"payload"`
	Attempts int            `yaml:"attempts" json:"attempts"`
}

type Response struct {
	Format     dbio.FileType `yaml:"format" json:"format,omitempty"` // force response format
	Records    Records       `yaml:"records" json:"records"`
	Processors []Processor   `yaml:"processors" json:"processors,omitempty"`
	Rules      []Rule        `yaml:"rules" json:"rules,omitempty"`

	// Modifier fields for prepending/appending to defaults (populated by custom unmarshal)
	// Use +rules to prepend rules (evaluated before defaults)
	// Use rules+ to append rules (evaluated after defaults, before hardcoded)
	PrependRules      []Rule      `yaml:"-" json:"-"`
	AppendRules       []Rule      `yaml:"-" json:"-"`
	PrependProcessors []Processor `yaml:"-" json:"-"`
	AppendProcessors  []Processor `yaml:"-" json:"-"`
}

type ResponseState struct {
	Status  int              `yaml:"status" json:"status"`
	Headers map[string]any   `yaml:"headers" json:"headers"`
	Text    string           `yaml:"text" json:"text"`
	JSON    any              `yaml:"json" json:"json"`
	Records []map[string]any `yaml:"records" json:"records"`
}

type Rule struct {
	Action      RuleType    `yaml:"action" json:"action"`
	Condition   string      `yaml:"condition" json:"condition"` // an expression
	MaxAttempts int         `yaml:"max_attempts" json:"max_attempts"`
	Backoff     BackoffType `yaml:"backoff" json:"backoff"`
	BackoffBase int         `yaml:"backoff_base" json:"backoff_base"` // base duration, number of seconds. default is 1
	Message     string      `yaml:"message" json:"message"`
}

type RuleType string

type Sequence []Call

type SingleRequest struct {
	Request  *RequestState  `yaml:"request" json:"request"`
	Response *ResponseState `yaml:"response" json:"response"`
	// contains filtered or unexported fields
}

type Spec struct {
	Name             string           `yaml:"name" json:"name"`
	Description      string           `yaml:"description" json:"description"`
	Queues           []string         `yaml:"queues" json:"queues"`
	Defaults         Endpoint         `yaml:"defaults" json:"defaults"`
	Authentication   Authentication   `yaml:"authentication" json:"authentication"`
	EndpointMap      EndpointMap      `yaml:"endpoints" json:"endpoints"`
	DynamicEndpoints DynamicEndpoints `yaml:"dynamic_endpoints" json:"dynamic_endpoints"`
	// contains filtered or unexported fields
}

type StateMap map[string]any