api

Dec 23, 2025

Changes in this version

type APIConnection

+ func (ac *APIConnection) GetSyncUpdateKey(endpointName string) (syncKey, updateKey string, err error)

Dec 20, 2025

Changes in this version

type APIConnection

+ func (ac *APIConnection) GetTestEndpoint() string

type APIStreamConfig

+ PrimaryKey []string

Dec 7, 2025

Changes in this version

type APIConnection

+ Name string

type APIState

+ Inputs map[string]any

type AggregateState

+ func NewAggregateState() AggregateState

type AggregationType

+ const AggregationTypeCollect

type AuthType

+ const AuthTypeStatic

+ type AuthenticatorStatic struct

+ Headers map[string]string

+ func (a *AuthenticatorStatic) Authenticate(ctx context.Context, state *APIStateAuth) (err error)

type Call

+ Authentication *Authentication

+ Into string

+ Iterate string

type Endpoint

+ Authentication *Authentication

+ Dynamic bool

+ func (ep *Endpoint) Authenticate() (err error)

+ func (ep *Endpoint) EnsureAuthenticated() error

+ func (ep *Endpoint) IsAuthExpired() bool

+ func (ep *Endpoint) MakeAuthenticator() (authenticator Authenticator, err error)

+ func (ep *Endpoint) UnmarshalYAML(unmarshal func(interface{}) error) error

type Records

+ Casing string

+ Select []string

type Response

+ AppendProcessors []Processor

+ AppendRules []Rule

+ PrependProcessors []Processor

+ PrependRules []Rule

+ func (r *Response) UnmarshalYAML(unmarshal func(interface{}) error) error

type RuleType

+ const RuleTypeBreak

+ const RuleTypeSkip

type Spec

+ func (s *Spec) MD5() string

Nov 6, 2025

Changes in this version

type APIConnection

+ func (ac *APIConnection) CompileEndpoints() (compiledEndpoints Endpoints, err error)

+ func (ac *APIConnection) MakeAuthenticator() (authenticator Authenticator, err error)

type APIState

+ Store map[string]any

type APIStreamConfig

+ Range string

type AuthType

+ const AuthTypeHMAC

+ const AuthTypeMTls

+ func (at AuthType) String() string

+ type Authentication0 struct

+ AuthenticationURL string

+ AuthorizationURL string

+ AwsAccessKeyID string

+ AwsProfile string

+ AwsRegion string

+ AwsSecretAccessKey string

+ AwsService string

+ AwsSessionToken string

+ ClientID string

+ ClientSecret string

+ Expires int

+ Flow OAuthFlow

+ Password string

+ RedirectURI string

+ RefreshOnExpire bool

+ RefreshToken string

+ Scopes []string

+ Sequence Sequence

+ Token string

+ Type AuthType

+ Username string

+ type Authenticator interface

+ AuthType func() AuthType

+ Authenticate func(ctx context.Context, state *APIStateAuth) error

+ Refresh func(ctx context.Context, state *APIStateAuth) error

+ type AuthenticatorAWSSigV4 struct

+ AwsAccessKeyID string

+ AwsProfile string

+ AwsRegion string

+ AwsSecretAccessKey string

+ AwsService string

+ AwsSessionToken string

+ func (a *AuthenticatorAWSSigV4) Authenticate(ctx context.Context, state *APIStateAuth) (err error)

+ type AuthenticatorBase struct

+ Expires int

+ Type AuthType

+ func (a *AuthenticatorBase) AuthType() AuthType

+ func (a *AuthenticatorBase) Authenticate(ctx context.Context, state *APIStateAuth) (err error)

+ func (a *AuthenticatorBase) Refresh(ctx context.Context, state *APIStateAuth) (err error)

+ type AuthenticatorBasic struct

+ Password string

+ Username string

+ func (a *AuthenticatorBasic) Authenticate(ctx context.Context, state *APIStateAuth) (err error)

+ type AuthenticatorHMAC struct

+ Algorithm string

+ NonceLength int

+ ReqHeaders map[string]string

+ Secret string

+ SigningString string

+ func (a *AuthenticatorHMAC) Authenticate(ctx context.Context, state *APIStateAuth) (err error)

+ type AuthenticatorOAuth2 struct

+ AuthenticationURL string

+ AuthorizationURL string

+ ClientID string

+ ClientSecret string

+ DeviceAuthURL string

+ Flow OAuthFlow

+ RedirectURI string

+ Scopes []string

+ func (a *AuthenticatorOAuth2) Authenticate(ctx context.Context, state *APIStateAuth) (err error)

+ func (a *AuthenticatorOAuth2) LoadToken() (*oauth2.Token, error)

+ func (a *AuthenticatorOAuth2) SaveToken(tok *oauth2.Token) error

+ func (a *AuthenticatorOAuth2) TokenFile() string

+ type AuthenticatorSequence struct

+ Sequence Sequence

+ func (a *AuthenticatorSequence) Authenticate(ctx context.Context, state *APIStateAuth) (err error)

type Endpoint

+ func (ep *Endpoint) Evaluate(expr string, state map[string]interface{}) (result any, err error)

type OAuthFlow

+ const OAuthFlowDeviceCode

Oct 17, 2025

Changes in this version

type Authentication

+ AuthorizationURL string

type Endpoint

+ Overrides any

type Processor

+ If string

Sep 26, 2025

Changes in this version

type Endpoint

+ DependsOn []string

type Endpoints

+ func (eps Endpoints) DAG() [][]string

+ func (eps Endpoints) HasUpstreams(endpointName string) (upstreams []string)

+ func (eps Endpoints) Names() (names []string)

Sep 15, 2025

Changes in this version

+ var FetchSpec = func(_ string) (string, error)

Sep 3, 2025

Changes in this version

type APIConnection

+ func (ac *APIConnection) GetReplicationStore() (store map[string]any)

+ func (ac *APIConnection) SetReplicationStore(store map[string]any)

type Iteration

+ func (iter *Iteration) Debug(text string, args ...any)

Jul 23, 2025

Changes in this version

type APIConnection

+ func (ac *APIConnection) EnsureAuthenticated() error

+ func (ac *APIConnection) IsAuthExpired() bool

+ func (ac *APIConnection) RenderDynamicEndpoints() (err error)

type APIStateAuth

+ ExpiresAt int64

+ Mutex *sync.Mutex

type AuthType

+ const AuthTypeSequence

type Authentication

+ Expires int

+ Sequence Sequence

type Call

+ If string

+ Pagination Pagination

+ Request Request

+ Response Response

+ type DynamicEndpoint struct

+ Endpoint Endpoint

+ Into string

+ Iterate string

+ Setup Sequence

+ type DynamicEndpoints []DynamicEndpoint

type Endpoint

+ Setup Sequence

+ Teardown Sequence

type Iteration

+ func (iter *Iteration) DetermineStateRenderOrder() (order []string, err error)

+ type OAuthFlow string

+ const OAuthFlowAuthorizationCode

+ const OAuthFlowClientCredentials

+ const OAuthFlowPassword

+ const OAuthFlowRefreshToken

+ type Sequence []Call

Jun 27, 2025

Changes in this version

type APIStateAuth

+ Sign func(context.Context, *http.Request, []byte) error

type AuthType

+ const AuthTypeAWSSigV4

type Authentication

+ AwsAccessKeyID string

+ AwsProfile string

+ AwsRegion string

+ AwsSecretAccessKey string

+ AwsService string

+ AwsSessionToken string

type AuthenticationFlow

+ const AuthFlowAuthorizationCode

+ const AuthFlowClientCredentials

+ const AuthFlowPassword

+ const AuthFlowRefreshToken

type Response

+ Format dbio.FileType

Apr 27, 2025

Changes in this version

type APIStreamConfig

+ Mode string

type Iterate

+ Concurrency int

type Records

+ DuplicateTolerance string

type SingleRequest

+ func (lrs *SingleRequest) Trace(text string, args ...any)

type StateMap

+ func (sm StateMap) DetermineRenderOrder() (order []string, err error)

Apr 17, 2025

Changes in this version

+ var AggregationTypes = []AggregationType

+ var Functions = functions

+ var GlobalFunctionMap = Functions.Generate()

+ type APIConnection struct

+ Context *g.Context

+ Spec Spec

+ State *APIState

+ func NewAPIConnection(ctx context.Context, spec Spec, data map[string]any) (ac *APIConnection, err error)

+ func (ac *APIConnection) Authenticate() (err error)

+ func (ac *APIConnection) Close() error

+ func (ac *APIConnection) CloseAllQueues()

+ func (ac *APIConnection) GetQueue(name string) (*Queue, bool)

+ func (ac *APIConnection) GetSyncedState(endpointName string) (data map[string]map[string]any, err error)

+ func (ac *APIConnection) ListEndpoints(patterns ...string) (endpoints Endpoints, err error)

+ func (ac *APIConnection) MakeDynamicEndpointIterator(iter *Iterate) (err error)

+ func (ac *APIConnection) PutSyncedState(endpointName string, data map[string]map[string]any) (err error)

+ func (ac *APIConnection) ReadDataflow(endpointName string, sCfg APIStreamConfig) (df *iop.Dataflow, err error)

+ func (ac *APIConnection) RegisterQueue(name string) (*Queue, error)

+ func (ac *APIConnection) RemoveQueue(name string) error

+ type APIState struct

+ Auth APIStateAuth

+ Env map[string]string

+ Queues map[string]*Queue

+ Secrets map[string]any

+ State map[string]any

+ type APIStateAuth struct

+ Authenticated bool

+ Headers map[string]string

+ Token string

+ type APIStreamConfig struct

+ DsConfigMap map[string]any

+ Flatten int

+ JmesPath string

+ Limit int

+ Metadata iop.Metadata

+ Select []string

+ type AggregateState struct

+ type AggregationType string

+ const AggregationTypeFirst

+ const AggregationTypeFlatten

+ const AggregationTypeLast

+ const AggregationTypeMaximum

+ const AggregationTypeMinimum

+ const AggregationTypeNone

+ type AuthType string

+ const AuthTypeBasic

+ const AuthTypeBearer

+ const AuthTypeNone

+ const AuthTypeOAuth2

+ type Authentication struct

+ AuthenticationURL string

+ ClientID string

+ ClientSecret string

+ Flow AuthenticationFlow

+ Password string

+ RedirectURI string

+ RefreshOnExpire bool

+ RefreshToken string

+ Scopes []string

+ Token string

+ Type AuthType

+ Username string

+ type AuthenticationFlow string

+ type BackoffType string

+ const BackoffTypeConstant

+ const BackoffTypeExponential

+ const BackoffTypeJitter

+ const BackoffTypeLinear

+ const BackoffTypeNone

+ type Call interface

+ Execute func() error

+ ID func() string

+ Stage func() CallStage

+ Type func() CallType

+ type CallStage string

+ const CallStageEnd

+ const CallStagePost

+ const CallStagePre

+ const CallStageStart

+ type CallType string

+ const CallTypeAuth

+ const CallTypeRequest

+ type Calls []Call

+ type Endpoint struct

+ Description string

+ Disabled bool

+ Docs string

+ Iterate Iterate

+ Name string

+ Pagination Pagination

+ Request Request

+ Response Response

+ State StateMap

+ Sync []string

+ func (ep *Endpoint) SetStateVal(key string, val any)

+ type EndpointMap map[string]Endpoint

+ type Endpoints []Endpoint

+ func (eps Endpoints) Sort()

+ type HTTPMethod string

+ const MethodConnect

+ const MethodDelete

+ const MethodGet

+ const MethodHead

+ const MethodOptions

+ const MethodPatch

+ const MethodPost

+ const MethodPut

+ const MethodTrace

+ type Iterate struct

+ If string

+ Into string

+ Over any

+ type Iteration struct

+ type Pagination struct

+ NextState map[string]any

+ StopCondition string

+ type Processor struct

+ Aggregation AggregationType

+ Expression string

+ Output string

+ type Queue struct

+ File *os.File

+ Path string

+ Reader *bufio.Reader

+ Writer *bufio.Writer

+ func NewQueue(prefix string) (*Queue, error)

+ func (q *Queue) Append(data any) error

+ func (q *Queue) Close() error

+ func (q *Queue) Next() (any, bool, error)

+ func (q *Queue) Reset() error

+ type Records struct

+ JmesPath string

+ Limit int

+ PrimaryKey []string

+ UpdateKey string

+ type Request struct

+ Concurrency int

+ Headers map[string]any

+ Method HTTPMethod

+ Parameters map[string]any

+ Payload any

+ Rate float64

+ Timeout int

+ URL string

+ type RequestState struct

+ Attempts int

+ Headers map[string]any

+ Method string

+ Payload any

+ URL string

+ type Response struct

+ Processors []Processor

+ Records Records

+ Rules []Rule

+ type ResponseState struct

+ Headers map[string]any

+ JSON any

+ Records []any

+ Status int

+ Text string

+ type Rule struct

+ Action RuleType

+ Backoff BackoffType

+ BackoffBase int

+ Condition string

+ MaxAttempts int

+ Message string

+ type RuleType string

+ const RuleTypeContinue

+ const RuleTypeFail

+ const RuleTypeRetry

+ const RuleTypeStop

+ type SingleRequest struct

+ Aggregate AggregateState

+ Request *RequestState

+ Response *ResponseState

+ func NewSingleRequest(ep *Endpoint, iter *Iteration) *SingleRequest

+ func (lrs *SingleRequest) Debug(text string, args ...any)

+ func (lrs *SingleRequest) Map() map[string]any

+ func (lrs *SingleRequest) Records() []any

+ type Spec struct

+ Authentication Authentication

+ Calls Calls

+ Defaults Endpoint

+ Description string

+ DynamicEndpoints Endpoints

+ EndpointMap EndpointMap

+ Name string

+ OriginalMap map[string]any

+ Queues []string

+ func LoadSpec(specBody string) (spec Spec, err error)

+ func (s *Spec) IsDynamic() bool

+ type StateMap map[string]any