sdk

Oct 21, 2024

Changes in this version

+ type ConnectorGroup string

+ const ConnectorGroupAI

+ const ConnectorGroupApps

+ const ConnectorGroupCore

+ const ConnectorGroupScripts

+ const ConnectorGroupTools

+ func (ConnectorGroup) SQLTypeName() string

+ func (ConnectorGroup) Values() []string

+ func (_j *ConnectorGroup) Scan(value interface{}) error

+ func (_j *ConnectorGroup) UnmarshalBinary(text []byte) error

+ func (_j *ConnectorGroup) UnmarshalGQL(value interface{}) error

+ func (_j *ConnectorGroup) UnmarshalJSON(data []byte) error

+ func (_j *ConnectorGroup) UnmarshalText(text []byte) error

+ func (_j *ConnectorGroup) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (_j ConnectorGroup) IsValid() bool

+ func (_j ConnectorGroup) MarshalBinary() ([]byte, error)

+ func (_j ConnectorGroup) MarshalGQL(w io.Writer)

+ func (_j ConnectorGroup) MarshalJSON() ([]byte, error)

+ func (_j ConnectorGroup) MarshalText() ([]byte, error)

+ func (_j ConnectorGroup) MarshalYAML() (interface{}, error)

+ func (_j ConnectorGroup) String() string

+ func (_j ConnectorGroup) Validate() error

type ConnectorMetadata

+ Categories []string

+ Group ConnectorGroup

type CreateConnectorArgs

+ Categories []string

+ Group ConnectorGroup

Oct 3, 2024

Changes in this version

type CreateConnectorArgs

+ Type *sdkcore.ConnectorType

type RunContext

+ func (r *RunContext) GetContext() context.Context

Aug 26, 2024

Changes in this version

type OperationInfo

+ HelpText *string

type TriggerInfo

+ HelpText *string

Aug 19, 2024

Changes in this version

type RunContext

+ func (r *RunContext) IsRunMode() bool

+ func (r *RunContext) IsTestMode() bool

Aug 9, 2024

Changes in this version

type RunContext

+ func (r *RunContext) GetStepsState() map[string]*sdkcore.StepRunData

Jul 2, 2024

Changes in this version

type CreateConnectorArgs

+ Documentation string

type OperationInfo

+ Documentation *string

type TriggerInfo

+ Documentation *string

Jun 29, 2024

Changes in this version

type RunContext

+ func (r *RunContext) SetState(state *sdkcore.StepRunData)

Jun 28, 2024

Changes in this version

+ func InputToTypeSafely[T any](ctx *RunContext) (*T, error)

type RunContext

+ Log *sdkcore.Log

+ Metadata *sdkcore.WorkflowRunMetadata

+ func NewRunContext(ctx context.Context, step *sdkcore.ConnectorStep, state *sdkcore.StepRunData, ...) *RunContext

+ func (rctx *RunContext) GetRawInput() sdkcore.JSONObject

type TriggerInfo

+ Type sdkcore.TriggerType

Jun 1, 2024

Changes in this version

+ var ErrNoValidEnum = errors.New("not a valid enum")

+ func CreateTrigger(args CreateTriggerArgs)

+ func DownloadFile(url string) (*grab.Response, error)

+ func DynamicInputToType[T any](ctx *sdkcore.DynamicOptionsContext) *T

+ func InputToType[T any](ctx *RunContext) *T

+ func StringToFile(fileStr string) (*autoform.File, error)

+ func ValidateConnectorInfo(info *CreateConnectorArgs) error

+ func ValidateOperationInfo(info *OperationInfo) error

+ func ValidateTriggerInfo(info *TriggerInfo) error

+ type ConnectorCategory string

+ const AI

+ const Apps

+ const Core

+ const Scripts

+ const Tools

+ func ConnectorCategoryFromString(raw string) (ConnectorCategory, bool)

+ func ConnectorCategoryFromStringIgnoreCase(raw string) (ConnectorCategory, bool)

+ func (ConnectorCategory) SQLTypeName() string

+ func (ConnectorCategory) Values() []string

+ func (_j *ConnectorCategory) Scan(value interface{}) error

+ func (_j *ConnectorCategory) UnmarshalBinary(text []byte) error

+ func (_j *ConnectorCategory) UnmarshalGQL(value interface{}) error

+ func (_j *ConnectorCategory) UnmarshalJSON(data []byte) error

+ func (_j *ConnectorCategory) UnmarshalText(text []byte) error

+ func (_j *ConnectorCategory) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (_j ConnectorCategory) IsValid() bool

+ func (_j ConnectorCategory) MarshalBinary() ([]byte, error)

+ func (_j ConnectorCategory) MarshalGQL(w io.Writer)

+ func (_j ConnectorCategory) MarshalJSON() ([]byte, error)

+ func (_j ConnectorCategory) MarshalText() ([]byte, error)

+ func (_j ConnectorCategory) MarshalYAML() (interface{}, error)

+ func (_j ConnectorCategory) String() string

+ func (_j ConnectorCategory) Validate() error

+ type ConnectorMetadata struct

+ Authors []string

+ Category ConnectorCategory

+ Description string

+ DisplayName string

+ Logo string

+ Name string

+ Version string

+ type ConnectorPlugin struct

+ CreateArgs *CreateConnectorArgs

+ HasTrigger bool

+ Metadata *ConnectorMetadata

+ Operations map[string]IOperation

+ OperationsMetadata map[string]*sdkcore.Operation

+ TriggerMetadata map[string]*sdkcore.Trigger

+ Triggers map[string]ITrigger

+ VersionMetadata *sdkcore.ConnectorVersionMetadata

+ func CreateConnector(args *CreateConnectorArgs) (*ConnectorPlugin, error)

+ func NewConnectorPlugin(args *CreateConnectorArgs) (*ConnectorPlugin, error)

+ func (plugin *ConnectorPlugin) Authenticate(ctx context.Context)

+ func (plugin *ConnectorPlugin) Test(ctx context.Context)

+ type CreateConnectorArgs struct

+ Authors []string

+ Category ConnectorCategory

+ Description string

+ Logo string

+ Name string

+ Operations []IOperation

+ Triggers []ITrigger

+ Version string

+ type CreateIOperationArgs struct

+ Auth *func(ctx context.Context) (JSON, error)

+ Description string

+ GenerateSampleData *func(ctx context.Context) (JSON, error)

+ Input *map[string]interface{}

+ Name string

+ Output *map[string]interface{}

+ Run *func(ctx context.Context) (JSON, error)

+ Test *func(ctx context.Context) (JSON, error)

+ type CreateTriggerArgs struct

+ Auth *func(ctx context.Context) (JSON, error)

+ Description string

+ GenerateSampleData *func(ctx context.Context) (JSON, error)

+ Input *map[string]interface{}

+ Name string

+ Output *map[string]interface{}

+ Run *func(ctx context.Context) (JSON, error)

+ Test *func(ctx context.Context) (JSON, error)

+ type IConnectorPlugin interface

+ Authenticate func(ctx context.Context)

+ Test func(ctx context.Context)

+ type IOperation interface

+ GetInfo func() *OperationInfo

+ type IRunnable interface

+ Run func(ctx *RunContext) (JSON, error)

+ Test func(ctx *RunContext) (JSON, error)

+ type ITrigger interface

+ GetInfo func() *TriggerInfo

+ OnDisabled func(ctx *RunContext) error

+ OnEnabled func(ctx *RunContext) error

+ type JSON = any

+ type OperationInfo struct

+ Auth *sdkcore.AutoFormSchema

+ Description string

+ ErrorSettings sdkcore.StepErrorSettings

+ Input map[string]*sdkcore.AutoFormSchema

+ Name string

+ RequireAuth bool

+ SampleOutput sdkcore.JSONObject

+ type PauseMetadata struct

+ RequestID *string

+ Response *any

+ ResumeAt *time.Time

+ Type sdkcore.PauseType

+ type PauseMetadataFull struct

+ type RunContext struct

+ Auth *sdkcore.AuthContext

+ ExecutionType sdkcore.ExecutionType

+ Files sdkcore.FileManager

+ Input sdkcore.JSONObject

+ LastRun *time.Time

+ ResolvedInput any

+ State *sdkcore.StepsState

+ Step *sdkcore.ConnectorStep

+ TriggerType sdkcore.TriggerHookType

+ Workflow *sdkcore.WorkflowRunMetadata

+ func (rctx *RunContext) GetPauseTime() *time.Time

+ func (rctx *RunContext) IsPaused() bool

+ func (rctx *RunContext) PauseExecution(metadata PauseMetadata) (JSON, error)

+ func (rctx *RunContext) SetContext(ctx context.Context)

+ type SpiderTestRuntime struct

+ func NewSpiderTest(t *testing.T, instance *ConnectorPlugin) *SpiderTestRuntime

+ func (s *SpiderTestRuntime) Close() error

+ func (s *SpiderTestRuntime) GetConfig() *ConnectorMetadata

+ func (s *SpiderTestRuntime) OperationConfig(name string) *sdkcore.Operation

+ func (s *SpiderTestRuntime) Operations() []*sdkcore.Operation

+ func (s *SpiderTestRuntime) RunAuth() error

+ func (s *SpiderTestRuntime) RunOperation(name string, run *RunContext) (JSON, error)

+ func (s *SpiderTestRuntime) RunTrigger(name string, run *RunContext) (JSON, error)

+ func (s *SpiderTestRuntime) TriggerConfig(name string) *sdkcore.Trigger

+ func (s *SpiderTestRuntime) Triggers() []*sdkcore.Trigger

+ type TriggerInfo struct

+ Auth *sdkcore.AutoFormSchema

+ Description string

+ ErrorSettings sdkcore.StepErrorSettings

+ Input map[string]*sdkcore.AutoFormSchema

+ Name string

+ RequireAuth bool

+ SampleOutput sdkcore.JSONObject

+ Settings *sdkcore.TriggerSettings

+ type TriggerRunContext struct

+ Auth *sdkcore.AuthContext

+ Metadata *sdkcore.WorkflowRunMetadata

+ Trigger *sdkcore.Trigger