features

type CreateCronTrigger struct {
	// Name is the unique identifier for the cron trigger.
	Name string `json:"name"`

	// Expression is the cron expression that defines the schedule.
	Expression string `json:"expression"`

	// Input is the optional input data for the workflow.
	Input map[string]interface{} `json:"input,omitempty"`

	// AdditionalMetadata is optional metadata to associate with the cron trigger.
	AdditionalMetadata map[string]interface{} `json:"additionalMetadata,omitempty"`
}

type CreateRatelimitOpts struct {
	// key is the unique identifier for the rate limit
	Key string
	// limit is the maximum number of requests allowed within the duration
	Limit int
	// duration specifies the time period for the rate limit
	Duration types.RateLimitDuration
}

type CreateScheduledRunTrigger struct {
	// TriggerAt specifies when the workflow should be triggered.
	TriggerAt time.Time `json:"triggerAt"`

	// Input is the optional input data for the workflow.
	Input map[string]interface{} `json:"input,omitempty"`

	// AdditionalMetadata is optional metadata to associate with the scheduled run.
	AdditionalMetadata map[string]interface{} `json:"additionalMetadata,omitempty"`
}

type CronsClient interface {
	// Create creates a new cron workflow trigger.
	Create(workflowName string, cron CreateCronTrigger, ctx ...context.Context) (*rest.CronWorkflows, error)

	// Delete removes a cron workflow trigger.
	Delete(cronId string, ctx ...context.Context) error

	// List retrieves a collection of cron workflow triggers based on the provided parameters.
	List(opts rest.CronWorkflowListParams, ctx ...context.Context) (*rest.CronWorkflowsList, error)

	// Get retrieves a specific cron workflow trigger by its ID.
	Get(cronId string, ctx ...context.Context) (*rest.CronWorkflows, error)
}

type InvalidCronExpressionError struct {
	Expression string
}

type MetricsClient interface {
	// GetWorkflowMetrics retrieves metrics for a specific workflow.
	GetWorkflowMetrics(workflowId string, opts *rest.WorkflowGetMetricsParams, ctx ...context.Context) (*rest.WorkflowMetrics, error)

	// GetQueueMetrics retrieves tenant-wide queue metrics.
	GetQueueMetrics(opts *rest.TenantGetQueueMetricsParams, ctx ...context.Context) (*rest.TenantGetQueueMetricsResponse, error)

	// GetTaskQueueMetrics retrieves tenant-wide step run queue metrics.
	GetTaskQueueMetrics(ctx ...context.Context) (*rest.TenantGetStepRunQueueMetricsResponse, error)
}

type RateLimitsClient interface {
	// upsert creates or updates a rate limit with the provided options.
	Upsert(opts CreateRatelimitOpts) error

	// list retrieves rate limits based on the provided parameters (optional).
	List(opts *rest.RateLimitListParams, ctx ...context.Context) (*rest.RateLimitListResponse, error)
}

type RunsClient interface {
	// Get retrieves a workflow run by its ID.
	Get(runId string, ctx ...context.Context) (*rest.V1WorkflowRunGetResponse, error)

	// GetDetails retrieves detailed information about a workflow run by its ID.
	GetDetails(runId string, ctx ...context.Context) (*rest.WorkflowRunGetShapeResponse, error)

	// List retrieves a collection of workflow runs based on the provided parameters.
	List(opts rest.V1WorkflowRunListParams, ctx ...context.Context) (*rest.V1WorkflowRunListResponse, error)

	// Replay requests a task to be replayed within a workflow run.
	Replay(opts rest.V1ReplayTaskRequest, ctx ...context.Context) (*rest.V1TaskReplayResponse, error)

	// Cancel requests cancellation of a specific task within a workflow run.
	Cancel(opts rest.V1CancelTaskRequest, ctx ...context.Context) (*rest.V1TaskCancelResponse, error)
}

type SchedulesClient interface {
	// Create creates a new scheduled workflow run.
	Create(workflowName string, trigger CreateScheduledRunTrigger, ctx ...context.Context) (*rest.ScheduledWorkflows, error)

	// Delete removes a scheduled workflow run.
	Delete(scheduledRunId string, ctx ...context.Context) error

	// List retrieves a collection of scheduled workflow runs based on the provided parameters.
	List(opts rest.WorkflowScheduledListParams, ctx ...context.Context) (*rest.ScheduledWorkflowsList, error)

	// Get retrieves a specific scheduled workflow run by its ID.
	Get(scheduledRunId string, ctx ...context.Context) (*rest.ScheduledWorkflows, error)
}

type WorkersClient interface {
	// Get retrieves a worker by its ID.
	Get(workerId string, ctx ...context.Context) (*rest.Worker, error)

	// List retrieves all workers for the tenant.
	List(ctx ...context.Context) (*rest.WorkerList, error)

	// IsPaused checks if a worker is paused.
	IsPaused(workerId string, ctx ...context.Context) (bool, error)

	// Pause pauses a worker.
	Pause(workerId string, ctx ...context.Context) (*rest.Worker, error)

	// Unpause unpauses a worker.
	Unpause(workerId string, ctx ...context.Context) (*rest.Worker, error)
}

type WorkflowsClient interface {
	// Get retrieves a workflow by its name.
	Get(workflowName string, ctx ...context.Context) (*rest.Workflow, error)

	// GetId retrieves a workflow by its name.
	GetId(workflowName string, ctx ...context.Context) (uuid.UUID, error)

	// List retrieves all workflows for the tenant with optional filtering parameters.
	List(opts *rest.WorkflowListParams, ctx ...context.Context) (*rest.WorkflowList, error)

	// Delete removes a workflow by its name.
	Delete(workflowName string, ctx ...context.Context) (*rest.WorkflowDeleteResponse, error)
}