Documentation
¶
Overview ¶
Package openapi contains generated types from the Spooled OpenAPI spec.
This package is auto-generated. Do not edit manually. To regenerate, run: go generate ./...
Package openapi provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- Constants
- type AddDependenciesRequest
- type AddDependenciesRequestDependencyMode
- type AddDependenciesResponse
- type AddJobDependenciesJSONRequestBody
- type AdminCreateApiKeyJSONRequestBody
- type AdminCreateOrganizationJSONRequestBody
- type AdminCreateOrganizationRequest
- type AdminCreateOrganizationRequestPlanTier
- type AdminCreateOrganizationResponse
- type AdminDeleteOrganizationParams
- type AdminListOrganizationsParams
- type AdminListOrganizationsParamsPlanTier
- type AdminOrganizationDetail
- type AdminOrganizationList
- type AdminOrganizationSummary
- type AdminUpdateOrganizationJSONRequestBody
- type AdminUpdateOrganizationRequest
- type AdminUpdateOrganizationRequestPlanTier
- type AdminUpdateOrganizationRequestStripeSubscriptionStatus
- type ApiKeySummary
- type BatchJobStatus
- type BatchJobStatusParams
- type BillingStatus
- type BillingStatusPlanTier
- type BillingStatusSubscriptionStatus
- type BoostJobPriorityJSONRequestBody
- type BoostPriorityRequest
- type BoostPriorityResponse
- type BulkEnqueueJobsJSONRequestBody
- type BulkEnqueueRequest
- type BulkEnqueueResponse
- type BulkJobError
- type BulkJobItem
- type BulkJobResult
- type CheckEmailParams
- type CheckEmailResponse
- type CheckSlugParams
- type CheckSlugResponse
- type ClaimJobsJSONRequestBody
- type ClaimJobsRequest
- type ClaimJobsResponse
- type ClaimedJob
- type ClearWebhookTokenJSONBody
- type ClearWebhookTokenJSONRequestBody
- type CompleteJobJSONRequestBody
- type CompleteJobRequest
- type CompleteSignupJSONRequestBody
- type CompleteSignupRequest
- type CompleteSignupResponse
- type CompleteSignupResponseTokenType
- type CreateApiKeyJSONRequestBody
- type CreateApiKeyRequest
- type CreateApiKeyResponse
- type CreateBillingPortalJSONRequestBody
- type CreateJobJSONRequestBody
- type CreateJobRequest
- type CreateJobResponse
- type CreateOrganizationJSONRequestBody
- type CreateOrganizationRequest
- type CreateOutgoingWebhookJSONRequestBody
- type CreateOutgoingWebhookRequest
- type CreateOutgoingWebhookRequestEvents
- type CreatePortalRequest
- type CreatePortalResponse
- type CreateScheduleJSONRequestBody
- type CreateScheduleRequest
- type CreateScheduleResponse
- type CreateWorkflowJSONRequestBody
- type CreateWorkflowRequest
- type CreateWorkflowResponse
- type CurrentUserResponse
- type CustomWebhookJSONRequestBody
- type CustomWebhookParams
- type CustomWebhookRequest
- type DashboardData
- type DeleteQueueParams
- type DependencyInfo
- type ErrorResponse
- type FailJobJSONRequestBody
- type FailJobRequest
- type GenerateSlugJSONRequestBody
- type GenerateSlugRequest
- type GenerateSlugResponse
- type GetScheduleHistoryParams
- type HealthResponse
- type HealthResponseStatus
- type HeartbeatJobRequest
- type Job
- type JobHeartbeatJSONRequestBody
- type JobStats
- type JobStatus
- type JobSummary
- type JobSummaryStats
- type JobWithDependencies
- type ListDeadLetterQueueParams
- type ListJobsParams
- type ListJobsParamsStatus
- type ListSchedulesParams
- type ListWorkflowsParams
- type ListWorkflowsParamsStatus
- type LoginJSONRequestBody
- type LoginRequest
- type LoginResponse
- type LoginResponseTokenType
- type Organization
- type OrganizationPlanTier
- type OrganizationSummary
- type OutgoingWebhook
- type OutgoingWebhookDelivery
- type OutgoingWebhookDeliveryStatus
- type OutgoingWebhookEvents
- type OutgoingWebhookLastStatus
- type PauseQueueJSONRequestBody
- type PauseQueueRequest
- type PauseQueueResponse
- type PlanLimits
- type PlatformStats
- type PurgeDeadLetterQueueJSONRequestBody
- type PurgeDlqRequest
- type PurgeDlqResponse
- type QueueConfig
- type QueueConfigSummary
- type QueueStats
- type QueueSummary
- type RealtimeEvent
- type RealtimeEventType
- type RecentActivity
- type RefreshTokenJSONRequestBody
- type RefreshTokenRequest
- type RefreshTokenResponse
- type RefreshTokenResponseTokenType
- type RegisterWorkerJSONRequestBody
- type RegisterWorkerRequest
- type RegisterWorkerResponse
- type ResourceUsage
- type ResumeQueueResponse
- type RetryDeadLetterJobsJSONRequestBody
- type RetryDlqRequest
- type RetryDlqResponse
- type Schedule
- type ScheduleRun
- type ScheduleRunStatus
- type SignupOrganization
- type SseEventsHandlerParams
- type StartEmailLoginJSONRequestBody
- type StartEmailLoginRequest
- type StartEmailLoginResponse
- type StripeWebhookJSONBody
- type StripeWebhookJSONRequestBody
- type SystemInfo
- type TestWebhookResponse
- type TriggerScheduleResponse
- type UpdateApiKeyJSONRequestBody
- type UpdateApiKeyRequest
- type UpdateOrganizationJSONRequestBody
- type UpdateOrganizationRequest
- type UpdateOutgoingWebhookJSONRequestBody
- type UpdateOutgoingWebhookRequest
- type UpdateQueueConfigJSONRequestBody
- type UpdateScheduleJSONRequestBody
- type UpdateScheduleRequest
- type UpsertQueueConfigRequest
- type UsageInfo
- type UsageInfoPlan
- type UsageItem
- type UsageWarning
- type UsageWarningSeverity
- type ValidateTokenJSONRequestBody
- type ValidateTokenRequest
- type ValidateTokenResponse
- type VerifyEmailCodeJSONRequestBody
- type VerifyEmailLoginResponse
- type VerifyEmailLoginResponseTokenType
- type VerifyEmailLoginResponseType
- type VerifyEmailRequest
- type VerifyEmailResponse
- func (t VerifyEmailResponse) AsVerifyEmailLoginResponse() (VerifyEmailLoginResponse, error)
- func (t VerifyEmailResponse) AsVerifyEmailSignupResponse() (VerifyEmailSignupResponse, error)
- func (t VerifyEmailResponse) Discriminator() (string, error)
- func (t *VerifyEmailResponse) FromVerifyEmailLoginResponse(v VerifyEmailLoginResponse) error
- func (t *VerifyEmailResponse) FromVerifyEmailSignupResponse(v VerifyEmailSignupResponse) error
- func (t VerifyEmailResponse) MarshalJSON() ([]byte, error)
- func (t *VerifyEmailResponse) MergeVerifyEmailLoginResponse(v VerifyEmailLoginResponse) error
- func (t *VerifyEmailResponse) MergeVerifyEmailSignupResponse(v VerifyEmailSignupResponse) error
- func (t *VerifyEmailResponse) UnmarshalJSON(b []byte) error
- func (t VerifyEmailResponse) ValueByDiscriminator() (interface{}, error)
- type VerifyEmailSignupResponse
- type VerifyEmailSignupResponseType
- type WebhookResponse
- type WebhookTokenResponse
- type WebsocketHandlerParams
- type Worker
- type WorkerHealthSummary
- type WorkerHeartbeatJSONRequestBody
- type WorkerHeartbeatRequest
- type WorkerStatus
- type WorkerSummary
- type WorkflowJobDefinition
- type WorkflowJobDefinitionDependencyMode
- type WorkflowJobMapping
- type WorkflowResponse
- type WorkflowResponseStatus
Constants ¶
const ( AdminKeyAuthScopes = "AdminKeyAuth.Scopes" ApiKeyAuthScopes = "ApiKeyAuth.Scopes" BearerAuthScopes = "BearerAuth.Scopes" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddDependenciesRequest ¶
type AddDependenciesRequest struct {
DependencyMode *AddDependenciesRequestDependencyMode `json:"dependency_mode,omitempty"`
DependsOn []string `json:"depends_on"`
}
AddDependenciesRequest defines model for AddDependenciesRequest.
type AddDependenciesRequestDependencyMode ¶
type AddDependenciesRequestDependencyMode string
AddDependenciesRequestDependencyMode defines model for AddDependenciesRequest.DependencyMode.
const ( AddDependenciesRequestDependencyModeAll AddDependenciesRequestDependencyMode = "all" AddDependenciesRequestDependencyModeAny AddDependenciesRequestDependencyMode = "any" )
Defines values for AddDependenciesRequestDependencyMode.
type AddDependenciesResponse ¶
type AddDependenciesResponse struct {
DependenciesAdded int `json:"dependencies_added"`
DependenciesMet bool `json:"dependencies_met"`
}
AddDependenciesResponse defines model for AddDependenciesResponse.
type AddJobDependenciesJSONRequestBody ¶
type AddJobDependenciesJSONRequestBody = AddDependenciesRequest
AddJobDependenciesJSONRequestBody defines body for AddJobDependencies for application/json ContentType.
type AdminCreateApiKeyJSONRequestBody ¶
type AdminCreateApiKeyJSONRequestBody = CreateApiKeyRequest
AdminCreateApiKeyJSONRequestBody defines body for AdminCreateApiKey for application/json ContentType.
type AdminCreateOrganizationJSONRequestBody ¶
type AdminCreateOrganizationJSONRequestBody = AdminCreateOrganizationRequest
AdminCreateOrganizationJSONRequestBody defines body for AdminCreateOrganization for application/json ContentType.
type AdminCreateOrganizationRequest ¶
type AdminCreateOrganizationRequest struct {
BillingEmail *openapi_types.Email `json:"billing_email,omitempty"`
Name string `json:"name"`
PlanTier *AdminCreateOrganizationRequestPlanTier `json:"plan_tier,omitempty"`
Settings *map[string]interface{} `json:"settings,omitempty"`
Slug string `json:"slug"`
}
AdminCreateOrganizationRequest defines model for AdminCreateOrganizationRequest.
type AdminCreateOrganizationRequestPlanTier ¶
type AdminCreateOrganizationRequestPlanTier string
AdminCreateOrganizationRequestPlanTier defines model for AdminCreateOrganizationRequest.PlanTier.
const ( AdminCreateOrganizationRequestPlanTierEnterprise AdminCreateOrganizationRequestPlanTier = "enterprise" AdminCreateOrganizationRequestPlanTierFree AdminCreateOrganizationRequestPlanTier = "free" AdminCreateOrganizationRequestPlanTierPro AdminCreateOrganizationRequestPlanTier = "pro" AdminCreateOrganizationRequestPlanTierStarter AdminCreateOrganizationRequestPlanTier = "starter" )
Defines values for AdminCreateOrganizationRequestPlanTier.
type AdminCreateOrganizationResponse ¶
type AdminCreateOrganizationResponse struct {
// ApiKey Initial API key (shown only once)
ApiKey string `json:"api_key"`
ApiKeyId *string `json:"api_key_id,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
Id string `json:"id"`
Name string `json:"name"`
PlanTier string `json:"plan_tier"`
Slug string `json:"slug"`
}
AdminCreateOrganizationResponse defines model for AdminCreateOrganizationResponse.
type AdminDeleteOrganizationParams ¶
type AdminDeleteOrganizationParams struct {
// HardDelete Permanent deletion (cannot be undone)
HardDelete *bool `form:"hard_delete,omitempty" json:"hard_delete,omitempty"`
}
AdminDeleteOrganizationParams defines parameters for AdminDeleteOrganization.
type AdminListOrganizationsParams ¶
type AdminListOrganizationsParams struct {
// PlanTier Filter by plan tier
PlanTier *AdminListOrganizationsParamsPlanTier `form:"plan_tier,omitempty" json:"plan_tier,omitempty"`
// Search Search by name or slug
Search *string `form:"search,omitempty" json:"search,omitempty"`
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}
AdminListOrganizationsParams defines parameters for AdminListOrganizations.
type AdminListOrganizationsParamsPlanTier ¶
type AdminListOrganizationsParamsPlanTier string
AdminListOrganizationsParamsPlanTier defines parameters for AdminListOrganizations.
const ( AdminListOrganizationsParamsPlanTierEnterprise AdminListOrganizationsParamsPlanTier = "enterprise" AdminListOrganizationsParamsPlanTierFree AdminListOrganizationsParamsPlanTier = "free" AdminListOrganizationsParamsPlanTierPro AdminListOrganizationsParamsPlanTier = "pro" AdminListOrganizationsParamsPlanTierStarter AdminListOrganizationsParamsPlanTier = "starter" )
Defines values for AdminListOrganizationsParamsPlanTier.
type AdminOrganizationDetail ¶
type AdminOrganizationDetail struct {
BillingEmail *string `json:"billing_email,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
Id *string `json:"id,omitempty"`
IsActive *bool `json:"is_active,omitempty"`
Name *string `json:"name,omitempty"`
PlanTier *string `json:"plan_tier,omitempty"`
ResourceCounts *struct {
ApiKeys *int `json:"api_keys,omitempty"`
Queues *int `json:"queues,omitempty"`
Schedules *int `json:"schedules,omitempty"`
Webhooks *int `json:"webhooks,omitempty"`
Workers *int `json:"workers,omitempty"`
Workflows *int `json:"workflows,omitempty"`
} `json:"resource_counts,omitempty"`
Settings *map[string]interface{} `json:"settings,omitempty"`
Slug *string `json:"slug,omitempty"`
// StripeCancelAtPeriodEnd Whether subscription will cancel at period end
StripeCancelAtPeriodEnd *bool `json:"stripe_cancel_at_period_end"`
// StripeCurrentPeriodEnd Current billing period end date
StripeCurrentPeriodEnd *time.Time `json:"stripe_current_period_end"`
// StripeCustomerId Stripe customer ID linked to this organization
StripeCustomerId *string `json:"stripe_customer_id"`
// StripeSubscriptionId Stripe subscription ID for billing
StripeSubscriptionId *string `json:"stripe_subscription_id"`
// StripeSubscriptionStatus Stripe subscription status (active, past_due, canceled, etc.)
StripeSubscriptionStatus *string `json:"stripe_subscription_status"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
Usage *ResourceUsage `json:"usage,omitempty"`
}
AdminOrganizationDetail defines model for AdminOrganizationDetail.
type AdminOrganizationList ¶
type AdminOrganizationList struct {
Limit int `json:"limit"`
Offset int `json:"offset"`
Organizations []AdminOrganizationSummary `json:"organizations"`
Total int `json:"total"`
}
AdminOrganizationList defines model for AdminOrganizationList.
type AdminOrganizationSummary ¶
type AdminOrganizationSummary struct {
ActiveJobs *int `json:"active_jobs,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
Id *string `json:"id,omitempty"`
IsActive *bool `json:"is_active,omitempty"`
JobsToday *int `json:"jobs_today,omitempty"`
Name *string `json:"name,omitempty"`
PlanTier *string `json:"plan_tier,omitempty"`
Slug *string `json:"slug,omitempty"`
}
AdminOrganizationSummary defines model for AdminOrganizationSummary.
type AdminUpdateOrganizationJSONRequestBody ¶
type AdminUpdateOrganizationJSONRequestBody = AdminUpdateOrganizationRequest
AdminUpdateOrganizationJSONRequestBody defines body for AdminUpdateOrganization for application/json ContentType.
type AdminUpdateOrganizationRequest ¶
type AdminUpdateOrganizationRequest struct {
BillingEmail *openapi_types.Email `json:"billing_email,omitempty"`
// CustomLimits Custom limit overrides (null or empty object resets to plan defaults)
CustomLimits *map[string]interface{} `json:"custom_limits"`
IsActive *bool `json:"is_active,omitempty"`
Name *string `json:"name,omitempty"`
PlanTier *AdminUpdateOrganizationRequestPlanTier `json:"plan_tier,omitempty"`
Settings *map[string]interface{} `json:"settings,omitempty"`
// StripeCustomerId Link a Stripe customer to this organization
StripeCustomerId *string `json:"stripe_customer_id"`
// StripeSubscriptionId Link a Stripe subscription (triggers auto-reconciliation with Stripe)
StripeSubscriptionId *string `json:"stripe_subscription_id"`
// StripeSubscriptionStatus Subscription status (usually auto-filled by reconciliation)
StripeSubscriptionStatus *AdminUpdateOrganizationRequestStripeSubscriptionStatus `json:"stripe_subscription_status"`
}
AdminUpdateOrganizationRequest Update organization settings. All fields are optional.
When setting `stripe_subscription_id`, the backend will auto-reconcile with Stripe API to fetch the correct plan tier, subscription status, and billing period from Stripe.
type AdminUpdateOrganizationRequestPlanTier ¶
type AdminUpdateOrganizationRequestPlanTier string
AdminUpdateOrganizationRequestPlanTier defines model for AdminUpdateOrganizationRequest.PlanTier.
const ( AdminUpdateOrganizationRequestPlanTierEnterprise AdminUpdateOrganizationRequestPlanTier = "enterprise" AdminUpdateOrganizationRequestPlanTierFree AdminUpdateOrganizationRequestPlanTier = "free" AdminUpdateOrganizationRequestPlanTierPro AdminUpdateOrganizationRequestPlanTier = "pro" AdminUpdateOrganizationRequestPlanTierStarter AdminUpdateOrganizationRequestPlanTier = "starter" )
Defines values for AdminUpdateOrganizationRequestPlanTier.
type AdminUpdateOrganizationRequestStripeSubscriptionStatus ¶
type AdminUpdateOrganizationRequestStripeSubscriptionStatus string
AdminUpdateOrganizationRequestStripeSubscriptionStatus Subscription status (usually auto-filled by reconciliation)
const ( AdminUpdateOrganizationRequestStripeSubscriptionStatusActive AdminUpdateOrganizationRequestStripeSubscriptionStatus = "active" AdminUpdateOrganizationRequestStripeSubscriptionStatusCanceled AdminUpdateOrganizationRequestStripeSubscriptionStatus = "canceled" AdminUpdateOrganizationRequestStripeSubscriptionStatusIncomplete AdminUpdateOrganizationRequestStripeSubscriptionStatus = "incomplete" AdminUpdateOrganizationRequestStripeSubscriptionStatusPastDue AdminUpdateOrganizationRequestStripeSubscriptionStatus = "past_due" AdminUpdateOrganizationRequestStripeSubscriptionStatusTrialing AdminUpdateOrganizationRequestStripeSubscriptionStatus = "trialing" AdminUpdateOrganizationRequestStripeSubscriptionStatusUnpaid AdminUpdateOrganizationRequestStripeSubscriptionStatus = "unpaid" )
Defines values for AdminUpdateOrganizationRequestStripeSubscriptionStatus.
type ApiKeySummary ¶
type ApiKeySummary struct {
CreatedAt time.Time `json:"created_at"`
ExpiresAt *time.Time `json:"expires_at,omitempty"`
Id string `json:"id"`
IsActive bool `json:"is_active"`
LastUsed *time.Time `json:"last_used,omitempty"`
Name string `json:"name"`
Queues []string `json:"queues"`
RateLimit *int `json:"rate_limit,omitempty"`
}
ApiKeySummary defines model for ApiKeySummary.
type BatchJobStatus ¶
type BatchJobStatus struct {
CompletedAt *time.Time `json:"completed_at,omitempty"`
CreatedAt time.Time `json:"created_at"`
Id string `json:"id"`
QueueName string `json:"queue_name"`
RetryCount int `json:"retry_count"`
Status string `json:"status"`
}
BatchJobStatus defines model for BatchJobStatus.
type BatchJobStatusParams ¶
type BatchJobStatusParams struct {
// Ids Comma-separated list of job IDs
Ids string `form:"ids" json:"ids"`
}
BatchJobStatusParams defines parameters for BatchJobStatus.
type BillingStatus ¶
type BillingStatus struct {
CancelAtPeriodEnd *bool `json:"cancel_at_period_end,omitempty"`
CurrentPeriodEnd *time.Time `json:"current_period_end,omitempty"`
HasStripeCustomer *bool `json:"has_stripe_customer,omitempty"`
PlanTier BillingStatusPlanTier `json:"plan_tier"`
StripeCustomerId *string `json:"stripe_customer_id,omitempty"`
SubscriptionStatus *BillingStatusSubscriptionStatus `json:"subscription_status,omitempty"`
}
BillingStatus defines model for BillingStatus.
type BillingStatusPlanTier ¶
type BillingStatusPlanTier string
BillingStatusPlanTier defines model for BillingStatus.PlanTier.
const ( BillingStatusPlanTierEnterprise BillingStatusPlanTier = "enterprise" BillingStatusPlanTierFree BillingStatusPlanTier = "free" BillingStatusPlanTierPro BillingStatusPlanTier = "pro" BillingStatusPlanTierStarter BillingStatusPlanTier = "starter" )
Defines values for BillingStatusPlanTier.
type BillingStatusSubscriptionStatus ¶
type BillingStatusSubscriptionStatus string
BillingStatusSubscriptionStatus defines model for BillingStatus.SubscriptionStatus.
const ( BillingStatusSubscriptionStatusActive BillingStatusSubscriptionStatus = "active" BillingStatusSubscriptionStatusCanceled BillingStatusSubscriptionStatus = "canceled" BillingStatusSubscriptionStatusIncomplete BillingStatusSubscriptionStatus = "incomplete" BillingStatusSubscriptionStatusPastDue BillingStatusSubscriptionStatus = "past_due" BillingStatusSubscriptionStatusTrialing BillingStatusSubscriptionStatus = "trialing" )
Defines values for BillingStatusSubscriptionStatus.
type BoostJobPriorityJSONRequestBody ¶
type BoostJobPriorityJSONRequestBody = BoostPriorityRequest
BoostJobPriorityJSONRequestBody defines body for BoostJobPriority for application/json ContentType.
type BoostPriorityRequest ¶
type BoostPriorityRequest struct {
Priority int `json:"priority"`
}
BoostPriorityRequest defines model for BoostPriorityRequest.
type BoostPriorityResponse ¶
type BoostPriorityResponse struct {
JobId string `json:"job_id"`
NewPriority int `json:"new_priority"`
OldPriority int `json:"old_priority"`
}
BoostPriorityResponse defines model for BoostPriorityResponse.
type BulkEnqueueJobsJSONRequestBody ¶
type BulkEnqueueJobsJSONRequestBody = BulkEnqueueRequest
BulkEnqueueJobsJSONRequestBody defines body for BulkEnqueueJobs for application/json ContentType.
type BulkEnqueueRequest ¶
type BulkEnqueueRequest struct {
DefaultMaxRetries *int `json:"default_max_retries,omitempty"`
DefaultPriority *int `json:"default_priority,omitempty"`
DefaultTimeoutSeconds *int `json:"default_timeout_seconds,omitempty"`
Jobs []BulkJobItem `json:"jobs"`
QueueName string `json:"queue_name"`
}
BulkEnqueueRequest defines model for BulkEnqueueRequest.
type BulkEnqueueResponse ¶
type BulkEnqueueResponse struct {
Failed []BulkJobError `json:"failed"`
FailureCount int `json:"failure_count"`
Succeeded []BulkJobResult `json:"succeeded"`
SuccessCount int `json:"success_count"`
Total int `json:"total"`
}
BulkEnqueueResponse defines model for BulkEnqueueResponse.
type BulkJobError ¶
BulkJobError defines model for BulkJobError.
type BulkJobItem ¶
type BulkJobItem struct {
IdempotencyKey *string `json:"idempotency_key,omitempty"`
Payload map[string]interface{} `json:"payload"`
Priority *int `json:"priority,omitempty"`
ScheduledAt *time.Time `json:"scheduled_at,omitempty"`
}
BulkJobItem defines model for BulkJobItem.
type BulkJobResult ¶
type BulkJobResult struct {
Created bool `json:"created"`
Index int `json:"index"`
JobId string `json:"job_id"`
}
BulkJobResult defines model for BulkJobResult.
type CheckEmailParams ¶
type CheckEmailParams struct {
// Email Email address to check
Email openapi_types.Email `form:"email" json:"email"`
}
CheckEmailParams defines parameters for CheckEmail.
type CheckEmailResponse ¶
type CheckEmailResponse struct {
// Available Whether the email is available (no account exists)
Available bool `json:"available"`
// Exists Whether an account exists with this email
Exists bool `json:"exists"`
}
CheckEmailResponse defines model for CheckEmailResponse.
type CheckSlugParams ¶
type CheckSlugParams struct {
// Slug Slug to check
Slug string `form:"slug" json:"slug"`
}
CheckSlugParams defines parameters for CheckSlug.
type CheckSlugResponse ¶
type CheckSlugResponse struct {
Available bool `json:"available"`
// Suggestion Suggested alternative if not available
Suggestion *string `json:"suggestion,omitempty"`
Valid bool `json:"valid"`
}
CheckSlugResponse defines model for CheckSlugResponse.
type ClaimJobsJSONRequestBody ¶
type ClaimJobsJSONRequestBody = ClaimJobsRequest
ClaimJobsJSONRequestBody defines body for ClaimJobs for application/json ContentType.
type ClaimJobsRequest ¶
type ClaimJobsRequest struct {
// LeaseDurationSecs Lease duration in seconds
LeaseDurationSecs *int `json:"lease_duration_secs,omitempty"`
// Limit Maximum number of jobs to claim
Limit *int `json:"limit,omitempty"`
// QueueName Queue to claim jobs from
QueueName string `json:"queue_name"`
// WorkerId Worker identifier (for tracking)
WorkerId *string `json:"worker_id,omitempty"`
}
ClaimJobsRequest defines model for ClaimJobsRequest.
type ClaimJobsResponse ¶
type ClaimJobsResponse struct {
Jobs []ClaimedJob `json:"jobs"`
}
ClaimJobsResponse defines model for ClaimJobsResponse.
type ClaimedJob ¶
type ClaimedJob struct {
CreatedAt *time.Time `json:"created_at,omitempty"`
Id string `json:"id"`
LeaseExpiresAt time.Time `json:"lease_expires_at"`
MaxRetries *int `json:"max_retries,omitempty"`
Payload map[string]interface{} `json:"payload"`
Priority *int `json:"priority,omitempty"`
QueueName string `json:"queue_name"`
RetryCount *int `json:"retry_count,omitempty"`
Status string `json:"status"`
TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
}
ClaimedJob defines model for ClaimedJob.
type ClearWebhookTokenJSONBody ¶
type ClearWebhookTokenJSONBody struct {
// Confirm Must be true to confirm clearing the token
Confirm bool `json:"confirm"`
}
ClearWebhookTokenJSONBody defines parameters for ClearWebhookToken.
type ClearWebhookTokenJSONRequestBody ¶
type ClearWebhookTokenJSONRequestBody ClearWebhookTokenJSONBody
ClearWebhookTokenJSONRequestBody defines body for ClearWebhookToken for application/json ContentType.
type CompleteJobJSONRequestBody ¶
type CompleteJobJSONRequestBody = CompleteJobRequest
CompleteJobJSONRequestBody defines body for CompleteJob for application/json ContentType.
type CompleteJobRequest ¶
type CompleteJobRequest struct {
// Result Optional result data to store with the job
Result *map[string]interface{} `json:"result,omitempty"`
WorkerId *string `json:"worker_id,omitempty"`
}
CompleteJobRequest defines model for CompleteJobRequest.
type CompleteSignupJSONRequestBody ¶
type CompleteSignupJSONRequestBody = CompleteSignupRequest
CompleteSignupJSONRequestBody defines body for CompleteSignup for application/json ContentType.
type CompleteSignupRequest ¶
type CompleteSignupRequest struct {
Name string `json:"name"`
SignupToken string `json:"signup_token"`
Slug string `json:"slug"`
}
CompleteSignupRequest defines model for CompleteSignupRequest.
type CompleteSignupResponse ¶
type CompleteSignupResponse struct {
AccessToken string `json:"access_token"`
// ApiKey Initial API key (shown only once)
ApiKey string `json:"api_key"`
ExpiresIn int `json:"expires_in"`
Organization SignupOrganization `json:"organization"`
RefreshToken string `json:"refresh_token"`
TokenType CompleteSignupResponseTokenType `json:"token_type"`
}
CompleteSignupResponse defines model for CompleteSignupResponse.
type CompleteSignupResponseTokenType ¶
type CompleteSignupResponseTokenType string
CompleteSignupResponseTokenType defines model for CompleteSignupResponse.TokenType.
const (
CompleteSignupResponseTokenTypeBearer CompleteSignupResponseTokenType = "Bearer"
)
Defines values for CompleteSignupResponseTokenType.
type CreateApiKeyJSONRequestBody ¶
type CreateApiKeyJSONRequestBody = CreateApiKeyRequest
CreateApiKeyJSONRequestBody defines body for CreateApiKey for application/json ContentType.
type CreateApiKeyRequest ¶
type CreateApiKeyRequest struct {
ExpiresAt *time.Time `json:"expires_at,omitempty"`
Name string `json:"name"`
Queues *[]string `json:"queues,omitempty"`
RateLimit *int `json:"rate_limit,omitempty"`
}
CreateApiKeyRequest defines model for CreateApiKeyRequest.
type CreateApiKeyResponse ¶
type CreateApiKeyResponse struct {
CreatedAt time.Time `json:"created_at"`
ExpiresAt *time.Time `json:"expires_at,omitempty"`
Id string `json:"id"`
// Key The raw API key (only shown once)
Key string `json:"key"`
Name string `json:"name"`
}
CreateApiKeyResponse defines model for CreateApiKeyResponse.
type CreateBillingPortalJSONRequestBody ¶
type CreateBillingPortalJSONRequestBody = CreatePortalRequest
CreateBillingPortalJSONRequestBody defines body for CreateBillingPortal for application/json ContentType.
type CreateJobJSONRequestBody ¶
type CreateJobJSONRequestBody = CreateJobRequest
CreateJobJSONRequestBody defines body for CreateJob for application/json ContentType.
type CreateJobRequest ¶
type CreateJobRequest struct {
CompletionWebhook *string `json:"completion_webhook,omitempty"`
ExpiresAt *time.Time `json:"expires_at,omitempty"`
IdempotencyKey *string `json:"idempotency_key,omitempty"`
MaxRetries *int `json:"max_retries,omitempty"`
ParentJobId *string `json:"parent_job_id,omitempty"`
Payload map[string]interface{} `json:"payload"`
Priority *int `json:"priority,omitempty"`
QueueName string `json:"queue_name"`
ScheduledAt *time.Time `json:"scheduled_at,omitempty"`
Tags *map[string]interface{} `json:"tags,omitempty"`
TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
}
CreateJobRequest defines model for CreateJobRequest.
type CreateJobResponse ¶
type CreateJobResponse struct {
// Created Whether this was a new job or existing
Created bool `json:"created"`
// Id Job ID (new or existing if idempotent)
Id string `json:"id"`
}
CreateJobResponse defines model for CreateJobResponse.
type CreateOrganizationJSONRequestBody ¶
type CreateOrganizationJSONRequestBody = CreateOrganizationRequest
CreateOrganizationJSONRequestBody defines body for CreateOrganization for application/json ContentType.
type CreateOrganizationRequest ¶
type CreateOrganizationRequest struct {
BillingEmail *openapi_types.Email `json:"billing_email,omitempty"`
Name string `json:"name"`
Slug string `json:"slug"`
}
CreateOrganizationRequest defines model for CreateOrganizationRequest.
type CreateOutgoingWebhookJSONRequestBody ¶
type CreateOutgoingWebhookJSONRequestBody = CreateOutgoingWebhookRequest
CreateOutgoingWebhookJSONRequestBody defines body for CreateOutgoingWebhook for application/json ContentType.
type CreateOutgoingWebhookRequest ¶
type CreateOutgoingWebhookRequest struct {
Enabled *bool `json:"enabled,omitempty"`
Events []CreateOutgoingWebhookRequestEvents `json:"events"`
Name string `json:"name"`
// Secret Optional HMAC secret for signing webhook payloads
Secret *string `json:"secret,omitempty"`
Url string `json:"url"`
}
CreateOutgoingWebhookRequest defines model for CreateOutgoingWebhookRequest.
type CreateOutgoingWebhookRequestEvents ¶
type CreateOutgoingWebhookRequestEvents string
CreateOutgoingWebhookRequestEvents defines model for CreateOutgoingWebhookRequest.Events.
const ( CreateOutgoingWebhookRequestEventsJobCancelled CreateOutgoingWebhookRequestEvents = "job.cancelled" CreateOutgoingWebhookRequestEventsJobCompleted CreateOutgoingWebhookRequestEvents = "job.completed" CreateOutgoingWebhookRequestEventsJobCreated CreateOutgoingWebhookRequestEvents = "job.created" CreateOutgoingWebhookRequestEventsJobFailed CreateOutgoingWebhookRequestEvents = "job.failed" CreateOutgoingWebhookRequestEventsJobStarted CreateOutgoingWebhookRequestEvents = "job.started" CreateOutgoingWebhookRequestEventsQueuePaused CreateOutgoingWebhookRequestEvents = "queue.paused" CreateOutgoingWebhookRequestEventsQueueResumed CreateOutgoingWebhookRequestEvents = "queue.resumed" CreateOutgoingWebhookRequestEventsScheduleTriggered CreateOutgoingWebhookRequestEvents = "schedule.triggered" CreateOutgoingWebhookRequestEventsWorkerDeregistered CreateOutgoingWebhookRequestEvents = "worker.deregistered" CreateOutgoingWebhookRequestEventsWorkerRegistered CreateOutgoingWebhookRequestEvents = "worker.registered" )
Defines values for CreateOutgoingWebhookRequestEvents.
type CreatePortalRequest ¶
type CreatePortalRequest struct {
ReturnUrl string `json:"return_url"`
}
CreatePortalRequest defines model for CreatePortalRequest.
type CreatePortalResponse ¶
type CreatePortalResponse struct {
// Url Stripe Customer Portal URL
Url string `json:"url"`
}
CreatePortalResponse defines model for CreatePortalResponse.
type CreateScheduleJSONRequestBody ¶
type CreateScheduleJSONRequestBody = CreateScheduleRequest
CreateScheduleJSONRequestBody defines body for CreateSchedule for application/json ContentType.
type CreateScheduleRequest ¶
type CreateScheduleRequest struct {
// CronExpression 6-field cron expression
CronExpression string `json:"cron_expression"`
Description *string `json:"description,omitempty"`
MaxRetries *int `json:"max_retries,omitempty"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
Name string `json:"name"`
PayloadTemplate map[string]interface{} `json:"payload_template"`
Priority *int `json:"priority,omitempty"`
QueueName string `json:"queue_name"`
Tags *map[string]interface{} `json:"tags,omitempty"`
TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
Timezone *string `json:"timezone,omitempty"`
}
CreateScheduleRequest defines model for CreateScheduleRequest.
type CreateScheduleResponse ¶
type CreateScheduleResponse struct {
CronExpression string `json:"cron_expression"`
Id string `json:"id"`
Name string `json:"name"`
NextRunAt *time.Time `json:"next_run_at,omitempty"`
}
CreateScheduleResponse defines model for CreateScheduleResponse.
type CreateWorkflowJSONRequestBody ¶
type CreateWorkflowJSONRequestBody = CreateWorkflowRequest
CreateWorkflowJSONRequestBody defines body for CreateWorkflow for application/json ContentType.
type CreateWorkflowRequest ¶
type CreateWorkflowRequest struct {
Description *string `json:"description,omitempty"`
Jobs []WorkflowJobDefinition `json:"jobs"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
Name string `json:"name"`
}
CreateWorkflowRequest defines model for CreateWorkflowRequest.
type CreateWorkflowResponse ¶
type CreateWorkflowResponse struct {
JobIds []WorkflowJobMapping `json:"job_ids"`
Status string `json:"status"`
WorkflowId openapi_types.UUID `json:"workflow_id"`
}
CreateWorkflowResponse defines model for CreateWorkflowResponse.
type CurrentUserResponse ¶
type CurrentUserResponse struct {
ApiKeyId string `json:"api_key_id"`
ExpiresAt time.Time `json:"expires_at"`
IssuedAt time.Time `json:"issued_at"`
OrganizationId string `json:"organization_id"`
Queues []string `json:"queues"`
}
CurrentUserResponse defines model for CurrentUserResponse.
type CustomWebhookJSONRequestBody ¶
type CustomWebhookJSONRequestBody = CustomWebhookRequest
CustomWebhookJSONRequestBody defines body for CustomWebhook for application/json ContentType.
type CustomWebhookParams ¶
type CustomWebhookParams struct {
// XWebhookToken Webhook authentication token. Required if the organization has configured
// a `webhook_token` in their settings.
XWebhookToken *string `json:"X-Webhook-Token,omitempty"`
}
CustomWebhookParams defines parameters for CustomWebhook.
type CustomWebhookRequest ¶
type CustomWebhookRequest struct {
EventType *string `json:"event_type,omitempty"`
IdempotencyKey *string `json:"idempotency_key,omitempty"`
Payload map[string]interface{} `json:"payload"`
Priority *int `json:"priority,omitempty"`
QueueName string `json:"queue_name"`
}
CustomWebhookRequest defines model for CustomWebhookRequest.
type DashboardData ¶
type DashboardData struct {
Jobs JobSummaryStats `json:"jobs"`
Queues []QueueSummary `json:"queues"`
RecentActivity RecentActivity `json:"recent_activity"`
System SystemInfo `json:"system"`
Workers WorkerHealthSummary `json:"workers"`
}
DashboardData defines model for DashboardData.
type DeleteQueueParams ¶
type DeleteQueueParams struct {
// DeleteJobs Also delete all jobs in the queue
DeleteJobs *bool `form:"delete_jobs,omitempty" json:"delete_jobs,omitempty"`
}
DeleteQueueParams defines parameters for DeleteQueue.
type DependencyInfo ¶
type DependencyInfo struct {
JobId string `json:"job_id"`
QueueName string `json:"queue_name"`
Status string `json:"status"`
}
DependencyInfo defines model for DependencyInfo.
type ErrorResponse ¶
type ErrorResponse struct {
// Code Machine-readable error code
Code string `json:"code"`
// Details Additional error details
Details *map[string]interface{} `json:"details,omitempty"`
// Message Human-readable error message
Message string `json:"message"`
}
ErrorResponse defines model for ErrorResponse.
type FailJobJSONRequestBody ¶
type FailJobJSONRequestBody = FailJobRequest
FailJobJSONRequestBody defines body for FailJob for application/json ContentType.
type FailJobRequest ¶
type FailJobRequest struct {
// NoRetry Skip retries and go directly to DLQ
NoRetry *bool `json:"no_retry,omitempty"`
// Reason Reason for failure
Reason string `json:"reason"`
WorkerId *string `json:"worker_id,omitempty"`
}
FailJobRequest defines model for FailJobRequest.
type GenerateSlugJSONRequestBody ¶
type GenerateSlugJSONRequestBody = GenerateSlugRequest
GenerateSlugJSONRequestBody defines body for GenerateSlug for application/json ContentType.
type GenerateSlugRequest ¶
type GenerateSlugRequest struct {
Name string `json:"name"`
}
GenerateSlugRequest defines model for GenerateSlugRequest.
type GenerateSlugResponse ¶
type GenerateSlugResponse struct {
Slug string `json:"slug"`
}
GenerateSlugResponse defines model for GenerateSlugResponse.
type GetScheduleHistoryParams ¶
type GetScheduleHistoryParams struct {
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}
GetScheduleHistoryParams defines parameters for GetScheduleHistory.
type HealthResponse ¶
type HealthResponse struct {
Cache bool `json:"cache"`
Database bool `json:"database"`
Status HealthResponseStatus `json:"status"`
Version string `json:"version"`
}
HealthResponse defines model for HealthResponse.
type HealthResponseStatus ¶
type HealthResponseStatus string
HealthResponseStatus defines model for HealthResponse.Status.
const ( HealthResponseStatusDegraded HealthResponseStatus = "degraded" HealthResponseStatusHealthy HealthResponseStatus = "healthy" )
Defines values for HealthResponseStatus.
type HeartbeatJobRequest ¶
type HeartbeatJobRequest struct {
// ExtensionSecs Extend lease by this many seconds
ExtensionSecs *int `json:"extension_secs,omitempty"`
WorkerId *string `json:"worker_id,omitempty"`
}
HeartbeatJobRequest defines model for HeartbeatJobRequest.
type Job ¶
type Job struct {
AssignedWorkerId *string `json:"assigned_worker_id,omitempty"`
CompletedAt *time.Time `json:"completed_at,omitempty"`
CompletionWebhook *string `json:"completion_webhook,omitempty"`
CreatedAt time.Time `json:"created_at"`
ExpiresAt *time.Time `json:"expires_at,omitempty"`
Id string `json:"id"`
IdempotencyKey *string `json:"idempotency_key,omitempty"`
LastError *string `json:"last_error,omitempty"`
LeaseExpiresAt *time.Time `json:"lease_expires_at,omitempty"`
LeaseId *string `json:"lease_id,omitempty"`
MaxRetries int `json:"max_retries"`
OrganizationId string `json:"organization_id"`
ParentJobId *string `json:"parent_job_id,omitempty"`
Payload map[string]interface{} `json:"payload"`
Priority int `json:"priority"`
QueueName string `json:"queue_name"`
Result *map[string]interface{} `json:"result,omitempty"`
RetryCount int `json:"retry_count"`
ScheduledAt *time.Time `json:"scheduled_at,omitempty"`
StartedAt *time.Time `json:"started_at,omitempty"`
Status JobStatus `json:"status"`
Tags *map[string]interface{} `json:"tags,omitempty"`
TimeoutSeconds int `json:"timeout_seconds"`
UpdatedAt time.Time `json:"updated_at"`
}
Job defines model for Job.
type JobHeartbeatJSONRequestBody ¶
type JobHeartbeatJSONRequestBody = HeartbeatJobRequest
JobHeartbeatJSONRequestBody defines body for JobHeartbeat for application/json ContentType.
type JobStats ¶
type JobStats struct {
Cancelled int `json:"cancelled"`
Completed int `json:"completed"`
Deadletter int `json:"deadletter"`
Failed int `json:"failed"`
Pending int `json:"pending"`
Processing int `json:"processing"`
Scheduled int `json:"scheduled"`
Total int `json:"total"`
}
JobStats defines model for JobStats.
type JobStatus ¶
type JobStatus string
JobStatus defines model for Job.Status.
const ( JobStatusCancelled JobStatus = "cancelled" JobStatusCompleted JobStatus = "completed" JobStatusDeadletter JobStatus = "deadletter" JobStatusFailed JobStatus = "failed" JobStatusPending JobStatus = "pending" JobStatusProcessing JobStatus = "processing" JobStatusScheduled JobStatus = "scheduled" )
Defines values for JobStatus.
type JobSummary ¶
type JobSummary struct {
CompletedAt *time.Time `json:"completed_at,omitempty"`
CreatedAt time.Time `json:"created_at"`
Id string `json:"id"`
Priority int `json:"priority"`
QueueName string `json:"queue_name"`
RetryCount int `json:"retry_count"`
ScheduledAt *time.Time `json:"scheduled_at,omitempty"`
StartedAt *time.Time `json:"started_at,omitempty"`
Status string `json:"status"`
}
JobSummary defines model for JobSummary.
type JobSummaryStats ¶
type JobSummaryStats struct {
AvgProcessingTimeMs *float32 `json:"avg_processing_time_ms,omitempty"`
AvgWaitTimeMs *float32 `json:"avg_wait_time_ms,omitempty"`
Completed24h int `json:"completed_24h"`
Deadletter int `json:"deadletter"`
Failed24h int `json:"failed_24h"`
Pending int `json:"pending"`
Processing int `json:"processing"`
Total int `json:"total"`
}
JobSummaryStats defines model for JobSummaryStats.
type JobWithDependencies ¶
type JobWithDependencies struct {
Dependencies []DependencyInfo `json:"dependencies"`
DependenciesMet bool `json:"dependencies_met"`
Dependents []DependencyInfo `json:"dependents"`
JobId string `json:"job_id"`
}
JobWithDependencies defines model for JobWithDependencies.
type ListDeadLetterQueueParams ¶
type ListDeadLetterQueueParams struct {
// QueueName Filter by queue name
QueueName *string `form:"queue_name,omitempty" json:"queue_name,omitempty"`
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}
ListDeadLetterQueueParams defines parameters for ListDeadLetterQueue.
type ListJobsParams ¶
type ListJobsParams struct {
// QueueName Filter by queue name
QueueName *string `form:"queue_name,omitempty" json:"queue_name,omitempty"`
// Status Filter by status
Status *ListJobsParamsStatus `form:"status,omitempty" json:"status,omitempty"`
// Limit Maximum number of results
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
// Offset Offset for pagination
Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}
ListJobsParams defines parameters for ListJobs.
type ListJobsParamsStatus ¶
type ListJobsParamsStatus string
ListJobsParamsStatus defines parameters for ListJobs.
const ( ListJobsParamsStatusCancelled ListJobsParamsStatus = "cancelled" ListJobsParamsStatusCompleted ListJobsParamsStatus = "completed" ListJobsParamsStatusDeadletter ListJobsParamsStatus = "deadletter" ListJobsParamsStatusFailed ListJobsParamsStatus = "failed" ListJobsParamsStatusPending ListJobsParamsStatus = "pending" ListJobsParamsStatusProcessing ListJobsParamsStatus = "processing" ListJobsParamsStatusScheduled ListJobsParamsStatus = "scheduled" )
Defines values for ListJobsParamsStatus.
type ListSchedulesParams ¶
type ListSchedulesParams struct {
OrganizationId *string `form:"organization_id,omitempty" json:"organization_id,omitempty"`
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}
ListSchedulesParams defines parameters for ListSchedules.
type ListWorkflowsParams ¶
type ListWorkflowsParams struct {
Status *ListWorkflowsParamsStatus `form:"status,omitempty" json:"status,omitempty"`
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}
ListWorkflowsParams defines parameters for ListWorkflows.
type ListWorkflowsParamsStatus ¶
type ListWorkflowsParamsStatus string
ListWorkflowsParamsStatus defines parameters for ListWorkflows.
const ( Cancelled ListWorkflowsParamsStatus = "cancelled" Completed ListWorkflowsParamsStatus = "completed" Failed ListWorkflowsParamsStatus = "failed" Pending ListWorkflowsParamsStatus = "pending" Running ListWorkflowsParamsStatus = "running" )
Defines values for ListWorkflowsParamsStatus.
type LoginJSONRequestBody ¶
type LoginJSONRequestBody = LoginRequest
LoginJSONRequestBody defines body for Login for application/json ContentType.
type LoginRequest ¶
type LoginRequest struct {
// ApiKey API key to exchange for JWT tokens
ApiKey string `json:"api_key"`
}
LoginRequest defines model for LoginRequest.
type LoginResponse ¶
type LoginResponse struct {
// AccessToken JWT access token (short-lived)
AccessToken string `json:"access_token"`
// ExpiresIn Access token expiration in seconds
ExpiresIn int `json:"expires_in"`
// RefreshExpiresIn Refresh token expiration in seconds
RefreshExpiresIn int `json:"refresh_expires_in"`
// RefreshToken JWT refresh token (long-lived)
RefreshToken string `json:"refresh_token"`
TokenType LoginResponseTokenType `json:"token_type"`
}
LoginResponse defines model for LoginResponse.
type LoginResponseTokenType ¶
type LoginResponseTokenType string
LoginResponseTokenType defines model for LoginResponse.TokenType.
const (
LoginResponseTokenTypeBearer LoginResponseTokenType = "Bearer"
)
Defines values for LoginResponseTokenType.
type Organization ¶
type Organization struct {
BillingEmail *openapi_types.Email `json:"billing_email,omitempty"`
CreatedAt time.Time `json:"created_at"`
Id string `json:"id"`
Name string `json:"name"`
PlanTier OrganizationPlanTier `json:"plan_tier"`
Settings map[string]interface{} `json:"settings"`
Slug string `json:"slug"`
UpdatedAt time.Time `json:"updated_at"`
}
Organization defines model for Organization.
type OrganizationPlanTier ¶
type OrganizationPlanTier string
OrganizationPlanTier defines model for Organization.PlanTier.
const ( OrganizationPlanTierEnterprise OrganizationPlanTier = "enterprise" OrganizationPlanTierFree OrganizationPlanTier = "free" OrganizationPlanTierPro OrganizationPlanTier = "pro" OrganizationPlanTierStarter OrganizationPlanTier = "starter" )
Defines values for OrganizationPlanTier.
type OrganizationSummary ¶
type OrganizationSummary struct {
CreatedAt time.Time `json:"created_at"`
Id string `json:"id"`
Name string `json:"name"`
PlanTier string `json:"plan_tier"`
Slug string `json:"slug"`
}
OrganizationSummary defines model for OrganizationSummary.
type OutgoingWebhook ¶
type OutgoingWebhook struct {
CreatedAt time.Time `json:"created_at"`
Enabled bool `json:"enabled"`
Events []OutgoingWebhookEvents `json:"events"`
FailureCount int `json:"failure_count"`
Id string `json:"id"`
LastStatus *OutgoingWebhookLastStatus `json:"last_status,omitempty"`
LastTriggeredAt *time.Time `json:"last_triggered_at,omitempty"`
Name string `json:"name"`
OrganizationId string `json:"organization_id"`
UpdatedAt time.Time `json:"updated_at"`
Url string `json:"url"`
}
OutgoingWebhook defines model for OutgoingWebhook.
type OutgoingWebhookDelivery ¶
type OutgoingWebhookDelivery struct {
Attempts int `json:"attempts"`
CreatedAt time.Time `json:"created_at"`
DeliveredAt *time.Time `json:"delivered_at,omitempty"`
Error *string `json:"error,omitempty"`
Event string `json:"event"`
Id string `json:"id"`
Payload map[string]interface{} `json:"payload"`
ResponseBody *string `json:"response_body,omitempty"`
Status OutgoingWebhookDeliveryStatus `json:"status"`
StatusCode *int `json:"status_code,omitempty"`
WebhookId string `json:"webhook_id"`
}
OutgoingWebhookDelivery defines model for OutgoingWebhookDelivery.
type OutgoingWebhookDeliveryStatus ¶
type OutgoingWebhookDeliveryStatus string
OutgoingWebhookDeliveryStatus defines model for OutgoingWebhookDelivery.Status.
const ( OutgoingWebhookDeliveryStatusFailed OutgoingWebhookDeliveryStatus = "failed" OutgoingWebhookDeliveryStatusPending OutgoingWebhookDeliveryStatus = "pending" OutgoingWebhookDeliveryStatusSuccess OutgoingWebhookDeliveryStatus = "success" )
Defines values for OutgoingWebhookDeliveryStatus.
type OutgoingWebhookEvents ¶
type OutgoingWebhookEvents string
OutgoingWebhookEvents defines model for OutgoingWebhook.Events.
const ( OutgoingWebhookEventsJobCancelled OutgoingWebhookEvents = "job.cancelled" OutgoingWebhookEventsJobCompleted OutgoingWebhookEvents = "job.completed" OutgoingWebhookEventsJobCreated OutgoingWebhookEvents = "job.created" OutgoingWebhookEventsJobFailed OutgoingWebhookEvents = "job.failed" OutgoingWebhookEventsJobStarted OutgoingWebhookEvents = "job.started" OutgoingWebhookEventsQueuePaused OutgoingWebhookEvents = "queue.paused" OutgoingWebhookEventsQueueResumed OutgoingWebhookEvents = "queue.resumed" OutgoingWebhookEventsScheduleTriggered OutgoingWebhookEvents = "schedule.triggered" OutgoingWebhookEventsWorkerDeregistered OutgoingWebhookEvents = "worker.deregistered" OutgoingWebhookEventsWorkerRegistered OutgoingWebhookEvents = "worker.registered" )
Defines values for OutgoingWebhookEvents.
type OutgoingWebhookLastStatus ¶
type OutgoingWebhookLastStatus string
OutgoingWebhookLastStatus defines model for OutgoingWebhook.LastStatus.
const ( OutgoingWebhookLastStatusFailed OutgoingWebhookLastStatus = "failed" OutgoingWebhookLastStatusSuccess OutgoingWebhookLastStatus = "success" )
Defines values for OutgoingWebhookLastStatus.
type PauseQueueJSONRequestBody ¶
type PauseQueueJSONRequestBody = PauseQueueRequest
PauseQueueJSONRequestBody defines body for PauseQueue for application/json ContentType.
type PauseQueueRequest ¶
type PauseQueueRequest struct {
// Reason Optional reason for pausing
Reason *string `json:"reason,omitempty"`
}
PauseQueueRequest defines model for PauseQueueRequest.
type PauseQueueResponse ¶
type PauseQueueResponse struct {
Paused bool `json:"paused"`
PausedAt time.Time `json:"paused_at"`
QueueName string `json:"queue_name"`
Reason *string `json:"reason,omitempty"`
}
PauseQueueResponse defines model for PauseQueueResponse.
type PlanLimits ¶
type PlanLimits struct {
DisplayName *string `json:"display_name,omitempty"`
HistoryRetentionDays *int `json:"history_retention_days,omitempty"`
JobRetentionDays *int `json:"job_retention_days,omitempty"`
MaxActiveJobs *int `json:"max_active_jobs"`
MaxApiKeys *int `json:"max_api_keys"`
MaxJobsPerDay *int `json:"max_jobs_per_day"`
MaxPayloadSizeBytes *int `json:"max_payload_size_bytes,omitempty"`
MaxQueues *int `json:"max_queues"`
MaxSchedules *int `json:"max_schedules"`
MaxWebhooks *int `json:"max_webhooks"`
MaxWorkers *int `json:"max_workers"`
MaxWorkflows *int `json:"max_workflows"`
RateLimitBurst *int `json:"rate_limit_burst,omitempty"`
RateLimitRequestsPerSecond *int `json:"rate_limit_requests_per_second,omitempty"`
Tier *string `json:"tier,omitempty"`
}
PlanLimits defines model for PlanLimits.
type PlatformStats ¶
type PlatformStats struct {
ActiveOrganizations *int `json:"active_organizations,omitempty"`
ActiveWorkers *int `json:"active_workers,omitempty"`
CompletedJobs24h *int `json:"completed_jobs_24h,omitempty"`
FailedJobs24h *int `json:"failed_jobs_24h,omitempty"`
OrganizationsByPlan *map[string]int `json:"organizations_by_plan,omitempty"`
TotalJobs24h *int `json:"total_jobs_24h,omitempty"`
TotalOrganizations *int `json:"total_organizations,omitempty"`
}
PlatformStats defines model for PlatformStats.
type PurgeDeadLetterQueueJSONRequestBody ¶
type PurgeDeadLetterQueueJSONRequestBody = PurgeDlqRequest
PurgeDeadLetterQueueJSONRequestBody defines body for PurgeDeadLetterQueue for application/json ContentType.
type PurgeDlqRequest ¶
type PurgeDlqRequest struct {
// Confirm Must be true to execute purge
Confirm bool `json:"confirm"`
OlderThan *time.Time `json:"older_than,omitempty"`
QueueName *string `json:"queue_name,omitempty"`
}
PurgeDlqRequest defines model for PurgeDlqRequest.
type PurgeDlqResponse ¶
type PurgeDlqResponse struct {
PurgedCount int `json:"purged_count"`
}
PurgeDlqResponse defines model for PurgeDlqResponse.
type QueueConfig ¶
type QueueConfig struct {
CreatedAt time.Time `json:"created_at"`
DefaultTimeout int `json:"default_timeout"`
Enabled bool `json:"enabled"`
Id string `json:"id"`
MaxRetries int `json:"max_retries"`
OrganizationId string `json:"organization_id"`
QueueName string `json:"queue_name"`
RateLimit *int `json:"rate_limit,omitempty"`
Settings map[string]interface{} `json:"settings"`
UpdatedAt time.Time `json:"updated_at"`
}
QueueConfig defines model for QueueConfig.
type QueueConfigSummary ¶
type QueueConfigSummary struct {
DefaultTimeout int `json:"default_timeout"`
Enabled bool `json:"enabled"`
MaxRetries int `json:"max_retries"`
QueueName string `json:"queue_name"`
RateLimit *int `json:"rate_limit,omitempty"`
}
QueueConfigSummary defines model for QueueConfigSummary.
type QueueStats ¶
type QueueStats struct {
ActiveWorkers int `json:"active_workers"`
AvgProcessingTimeMs *float32 `json:"avg_processing_time_ms,omitempty"`
CompletedJobs24h int `json:"completed_jobs_24h"`
FailedJobs24h int `json:"failed_jobs_24h"`
MaxJobAgeSeconds *int `json:"max_job_age_seconds,omitempty"`
PendingJobs int `json:"pending_jobs"`
ProcessingJobs int `json:"processing_jobs"`
QueueName string `json:"queue_name"`
}
QueueStats defines model for QueueStats.
type QueueSummary ¶
type QueueSummary struct {
Name string `json:"name"`
Paused bool `json:"paused"`
Pending int `json:"pending"`
Processing int `json:"processing"`
}
QueueSummary defines model for QueueSummary.
type RealtimeEvent ¶
type RealtimeEvent struct {
Data map[string]interface{} `json:"data"`
Type RealtimeEventType `json:"type"`
}
RealtimeEvent defines model for RealtimeEvent.
type RealtimeEventType ¶
type RealtimeEventType string
RealtimeEventType defines model for RealtimeEvent.Type.
const ( RealtimeEventTypeError RealtimeEventType = "error" RealtimeEventTypeJobCompleted RealtimeEventType = "job.completed" RealtimeEventTypeJobCreated RealtimeEventType = "job.created" RealtimeEventTypeJobFailed RealtimeEventType = "job.failed" RealtimeEventTypeJobStatus RealtimeEventType = "job.status" RealtimeEventTypePing RealtimeEventType = "ping" RealtimeEventTypeQueueStats RealtimeEventType = "queue.stats" RealtimeEventTypeSystemHealth RealtimeEventType = "system.health" RealtimeEventTypeWorkerDeregistered RealtimeEventType = "worker.deregistered" RealtimeEventTypeWorkerHeartbeat RealtimeEventType = "worker.heartbeat" RealtimeEventTypeWorkerRegistered RealtimeEventType = "worker.registered" )
Defines values for RealtimeEventType.
type RecentActivity ¶
type RecentActivity struct {
JobsCompleted1h int `json:"jobs_completed_1h"`
JobsCreated1h int `json:"jobs_created_1h"`
JobsFailed1h int `json:"jobs_failed_1h"`
}
RecentActivity defines model for RecentActivity.
type RefreshTokenJSONRequestBody ¶
type RefreshTokenJSONRequestBody = RefreshTokenRequest
RefreshTokenJSONRequestBody defines body for RefreshToken for application/json ContentType.
type RefreshTokenRequest ¶
type RefreshTokenRequest struct {
// RefreshToken Valid refresh token
RefreshToken string `json:"refresh_token"`
}
RefreshTokenRequest defines model for RefreshTokenRequest.
type RefreshTokenResponse ¶
type RefreshTokenResponse struct {
// AccessToken New JWT access token
AccessToken string `json:"access_token"`
// ExpiresIn Access token expiration in seconds
ExpiresIn int `json:"expires_in"`
TokenType RefreshTokenResponseTokenType `json:"token_type"`
}
RefreshTokenResponse defines model for RefreshTokenResponse.
type RefreshTokenResponseTokenType ¶
type RefreshTokenResponseTokenType string
RefreshTokenResponseTokenType defines model for RefreshTokenResponse.TokenType.
const (
RefreshTokenResponseTokenTypeBearer RefreshTokenResponseTokenType = "Bearer"
)
Defines values for RefreshTokenResponseTokenType.
type RegisterWorkerJSONRequestBody ¶
type RegisterWorkerJSONRequestBody = RegisterWorkerRequest
RegisterWorkerJSONRequestBody defines body for RegisterWorker for application/json ContentType.
type RegisterWorkerRequest ¶
type RegisterWorkerRequest struct {
Hostname string `json:"hostname"`
MaxConcurrency *int `json:"max_concurrency,omitempty"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
QueueName string `json:"queue_name"`
Version *string `json:"version,omitempty"`
WorkerType *string `json:"worker_type,omitempty"`
}
RegisterWorkerRequest defines model for RegisterWorkerRequest.
type RegisterWorkerResponse ¶
type RegisterWorkerResponse struct {
HeartbeatIntervalSecs int `json:"heartbeat_interval_secs"`
Id string `json:"id"`
LeaseDurationSecs int `json:"lease_duration_secs"`
QueueName string `json:"queue_name"`
}
RegisterWorkerResponse defines model for RegisterWorkerResponse.
type ResourceUsage ¶
type ResourceUsage struct {
ActiveJobs *UsageItem `json:"active_jobs,omitempty"`
ApiKeys *UsageItem `json:"api_keys,omitempty"`
JobsToday *UsageItem `json:"jobs_today,omitempty"`
Queues *UsageItem `json:"queues,omitempty"`
Schedules *UsageItem `json:"schedules,omitempty"`
Webhooks *UsageItem `json:"webhooks,omitempty"`
Workers *UsageItem `json:"workers,omitempty"`
Workflows *UsageItem `json:"workflows,omitempty"`
}
ResourceUsage defines model for ResourceUsage.
type ResumeQueueResponse ¶
type ResumeQueueResponse struct {
PausedDurationSecs int `json:"paused_duration_secs"`
QueueName string `json:"queue_name"`
Resumed bool `json:"resumed"`
}
ResumeQueueResponse defines model for ResumeQueueResponse.
type RetryDeadLetterJobsJSONRequestBody ¶
type RetryDeadLetterJobsJSONRequestBody = RetryDlqRequest
RetryDeadLetterJobsJSONRequestBody defines body for RetryDeadLetterJobs for application/json ContentType.
type RetryDlqRequest ¶
type RetryDlqRequest struct {
JobIds *[]string `json:"job_ids,omitempty"`
Limit *int `json:"limit,omitempty"`
QueueName *string `json:"queue_name,omitempty"`
}
RetryDlqRequest defines model for RetryDlqRequest.
type RetryDlqResponse ¶
type RetryDlqResponse struct {
RetriedCount int `json:"retried_count"`
RetriedJobs []string `json:"retried_jobs"`
}
RetryDlqResponse defines model for RetryDlqResponse.
type Schedule ¶
type Schedule struct {
CreatedAt time.Time `json:"created_at"`
// CronExpression 6-field cron expression (second minute hour day month weekday)
CronExpression string `json:"cron_expression"`
Description *string `json:"description,omitempty"`
Id string `json:"id"`
IsActive bool `json:"is_active"`
LastRunAt *time.Time `json:"last_run_at,omitempty"`
MaxRetries *int `json:"max_retries,omitempty"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
Name string `json:"name"`
NextRunAt *time.Time `json:"next_run_at,omitempty"`
OrganizationId string `json:"organization_id"`
PayloadTemplate *map[string]interface{} `json:"payload_template,omitempty"`
Priority *int `json:"priority,omitempty"`
QueueName string `json:"queue_name"`
RunCount *int `json:"run_count,omitempty"`
Tags *map[string]interface{} `json:"tags,omitempty"`
TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
Timezone string `json:"timezone"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
Schedule defines model for Schedule.
type ScheduleRun ¶
type ScheduleRun struct {
CompletedAt *time.Time `json:"completed_at,omitempty"`
ErrorMessage *string `json:"error_message,omitempty"`
Id string `json:"id"`
JobId *string `json:"job_id,omitempty"`
ScheduleId string `json:"schedule_id"`
StartedAt time.Time `json:"started_at"`
Status ScheduleRunStatus `json:"status"`
}
ScheduleRun defines model for ScheduleRun.
type ScheduleRunStatus ¶
type ScheduleRunStatus string
ScheduleRunStatus defines model for ScheduleRun.Status.
const ( ScheduleRunStatusCompleted ScheduleRunStatus = "completed" ScheduleRunStatusFailed ScheduleRunStatus = "failed" ScheduleRunStatusPending ScheduleRunStatus = "pending" ScheduleRunStatusRunning ScheduleRunStatus = "running" )
Defines values for ScheduleRunStatus.
type SignupOrganization ¶
type SignupOrganization struct {
BillingEmail openapi_types.Email `json:"billing_email"`
Id string `json:"id"`
Name string `json:"name"`
Slug string `json:"slug"`
}
SignupOrganization defines model for SignupOrganization.
type SseEventsHandlerParams ¶
type SseEventsHandlerParams struct {
Queue *string `form:"queue,omitempty" json:"queue,omitempty"`
// Events Comma-separated event types to filter
Events *string `form:"events,omitempty" json:"events,omitempty"`
}
SseEventsHandlerParams defines parameters for SseEventsHandler.
type StartEmailLoginJSONRequestBody ¶
type StartEmailLoginJSONRequestBody = StartEmailLoginRequest
StartEmailLoginJSONRequestBody defines body for StartEmailLogin for application/json ContentType.
type StartEmailLoginRequest ¶
type StartEmailLoginRequest struct {
Email openapi_types.Email `json:"email"`
}
StartEmailLoginRequest defines model for StartEmailLoginRequest.
type StartEmailLoginResponse ¶
type StartEmailLoginResponse struct {
// EmailSentTo Email address masked for privacy
EmailSentTo string `json:"email_sent_to"`
// Message Human-friendly status message
Message string `json:"message"`
}
StartEmailLoginResponse defines model for StartEmailLoginResponse.
type StripeWebhookJSONBody ¶
type StripeWebhookJSONBody = map[string]interface{}
StripeWebhookJSONBody defines parameters for StripeWebhook.
type StripeWebhookJSONRequestBody ¶
type StripeWebhookJSONRequestBody = StripeWebhookJSONBody
StripeWebhookJSONRequestBody defines body for StripeWebhook for application/json ContentType.
type SystemInfo ¶
type SystemInfo struct {
CacheStatus string `json:"cache_status"`
DatabaseStatus string `json:"database_status"`
Environment string `json:"environment"`
StartedAt time.Time `json:"started_at"`
UptimeSeconds int `json:"uptime_seconds"`
Version string `json:"version"`
}
SystemInfo defines model for SystemInfo.
type TestWebhookResponse ¶
type TestWebhookResponse struct {
Error *string `json:"error,omitempty"`
ResponseTimeMs int `json:"response_time_ms"`
StatusCode *int `json:"status_code,omitempty"`
Success bool `json:"success"`
}
TestWebhookResponse defines model for TestWebhookResponse.
type TriggerScheduleResponse ¶
type TriggerScheduleResponse struct {
JobId string `json:"job_id"`
TriggeredAt time.Time `json:"triggered_at"`
}
TriggerScheduleResponse defines model for TriggerScheduleResponse.
type UpdateApiKeyJSONRequestBody ¶
type UpdateApiKeyJSONRequestBody = UpdateApiKeyRequest
UpdateApiKeyJSONRequestBody defines body for UpdateApiKey for application/json ContentType.
type UpdateApiKeyRequest ¶
type UpdateApiKeyRequest struct {
IsActive *bool `json:"is_active,omitempty"`
Name *string `json:"name,omitempty"`
Queues *[]string `json:"queues,omitempty"`
RateLimit *int `json:"rate_limit,omitempty"`
}
UpdateApiKeyRequest defines model for UpdateApiKeyRequest.
type UpdateOrganizationJSONRequestBody ¶
type UpdateOrganizationJSONRequestBody = UpdateOrganizationRequest
UpdateOrganizationJSONRequestBody defines body for UpdateOrganization for application/json ContentType.
type UpdateOrganizationRequest ¶
type UpdateOrganizationRequest struct {
BillingEmail *openapi_types.Email `json:"billing_email,omitempty"`
Name *string `json:"name,omitempty"`
Settings *map[string]interface{} `json:"settings,omitempty"`
}
UpdateOrganizationRequest defines model for UpdateOrganizationRequest.
type UpdateOutgoingWebhookJSONRequestBody ¶
type UpdateOutgoingWebhookJSONRequestBody = UpdateOutgoingWebhookRequest
UpdateOutgoingWebhookJSONRequestBody defines body for UpdateOutgoingWebhook for application/json ContentType.
type UpdateOutgoingWebhookRequest ¶
type UpdateOutgoingWebhookRequest struct {
Enabled *bool `json:"enabled,omitempty"`
Events *[]string `json:"events,omitempty"`
Name *string `json:"name,omitempty"`
Secret *string `json:"secret,omitempty"`
Url *string `json:"url,omitempty"`
}
UpdateOutgoingWebhookRequest defines model for UpdateOutgoingWebhookRequest.
type UpdateQueueConfigJSONRequestBody ¶
type UpdateQueueConfigJSONRequestBody = UpsertQueueConfigRequest
UpdateQueueConfigJSONRequestBody defines body for UpdateQueueConfig for application/json ContentType.
type UpdateScheduleJSONRequestBody ¶
type UpdateScheduleJSONRequestBody = UpdateScheduleRequest
UpdateScheduleJSONRequestBody defines body for UpdateSchedule for application/json ContentType.
type UpdateScheduleRequest ¶
type UpdateScheduleRequest struct {
CronExpression *string `json:"cron_expression,omitempty"`
Description *string `json:"description,omitempty"`
IsActive *bool `json:"is_active,omitempty"`
MaxRetries *int `json:"max_retries,omitempty"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
Name *string `json:"name,omitempty"`
PayloadTemplate *map[string]interface{} `json:"payload_template,omitempty"`
Priority *int `json:"priority,omitempty"`
Tags *map[string]interface{} `json:"tags,omitempty"`
TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
Timezone *string `json:"timezone,omitempty"`
}
UpdateScheduleRequest defines model for UpdateScheduleRequest.
type UpsertQueueConfigRequest ¶
type UpsertQueueConfigRequest struct {
DefaultTimeout *int `json:"default_timeout,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
MaxRetries *int `json:"max_retries,omitempty"`
QueueName string `json:"queue_name"`
RateLimit *int `json:"rate_limit,omitempty"`
Settings *map[string]interface{} `json:"settings,omitempty"`
}
UpsertQueueConfigRequest defines model for UpsertQueueConfigRequest.
type UsageInfo ¶
type UsageInfo struct {
Limits PlanLimits `json:"limits"`
Plan UsageInfoPlan `json:"plan"`
Usage ResourceUsage `json:"usage"`
Warnings []UsageWarning `json:"warnings"`
}
UsageInfo defines model for UsageInfo.
type UsageInfoPlan ¶
type UsageInfoPlan string
UsageInfoPlan defines model for UsageInfo.Plan.
const ( UsageInfoPlanEnterprise UsageInfoPlan = "enterprise" UsageInfoPlanFree UsageInfoPlan = "free" UsageInfoPlanPro UsageInfoPlan = "pro" UsageInfoPlanStarter UsageInfoPlan = "starter" )
Defines values for UsageInfoPlan.
type UsageItem ¶
type UsageItem struct {
Current *int `json:"current,omitempty"`
Limit *int `json:"limit"`
Percentage *float32 `json:"percentage"`
}
UsageItem defines model for UsageItem.
type UsageWarning ¶
type UsageWarning struct {
Current *int `json:"current,omitempty"`
Limit *int `json:"limit,omitempty"`
Message *string `json:"message,omitempty"`
Resource *string `json:"resource,omitempty"`
Severity *UsageWarningSeverity `json:"severity,omitempty"`
}
UsageWarning defines model for UsageWarning.
type UsageWarningSeverity ¶
type UsageWarningSeverity string
UsageWarningSeverity defines model for UsageWarning.Severity.
const ( Critical UsageWarningSeverity = "critical" Warning UsageWarningSeverity = "warning" )
Defines values for UsageWarningSeverity.
type ValidateTokenJSONRequestBody ¶
type ValidateTokenJSONRequestBody = ValidateTokenRequest
ValidateTokenJSONRequestBody defines body for ValidateToken for application/json ContentType.
type ValidateTokenRequest ¶
type ValidateTokenRequest struct {
// Token JWT token to validate
Token string `json:"token"`
}
ValidateTokenRequest defines model for ValidateTokenRequest.
type ValidateTokenResponse ¶
type ValidateTokenResponse struct {
// Claims Token claims if valid
Claims *map[string]interface{} `json:"claims,omitempty"`
// Error Error message if token is invalid
Error *string `json:"error,omitempty"`
Valid bool `json:"valid"`
}
ValidateTokenResponse defines model for ValidateTokenResponse.
type VerifyEmailCodeJSONRequestBody ¶
type VerifyEmailCodeJSONRequestBody = VerifyEmailRequest
VerifyEmailCodeJSONRequestBody defines body for VerifyEmailCode for application/json ContentType.
type VerifyEmailLoginResponse ¶
type VerifyEmailLoginResponse struct {
AccessToken string `json:"access_token"`
ExpiresIn int `json:"expires_in"`
RefreshExpiresIn int `json:"refresh_expires_in"`
RefreshToken string `json:"refresh_token"`
TokenType VerifyEmailLoginResponseTokenType `json:"token_type"`
Type VerifyEmailLoginResponseType `json:"type"`
}
VerifyEmailLoginResponse defines model for VerifyEmailLoginResponse.
type VerifyEmailLoginResponseTokenType ¶
type VerifyEmailLoginResponseTokenType string
VerifyEmailLoginResponseTokenType defines model for VerifyEmailLoginResponse.TokenType.
const (
VerifyEmailLoginResponseTokenTypeBearer VerifyEmailLoginResponseTokenType = "Bearer"
)
Defines values for VerifyEmailLoginResponseTokenType.
type VerifyEmailLoginResponseType ¶
type VerifyEmailLoginResponseType string
VerifyEmailLoginResponseType defines model for VerifyEmailLoginResponse.Type.
const (
Login VerifyEmailLoginResponseType = "login"
)
Defines values for VerifyEmailLoginResponseType.
type VerifyEmailRequest ¶
type VerifyEmailRequest struct {
Code string `json:"code"`
Email openapi_types.Email `json:"email"`
}
VerifyEmailRequest defines model for VerifyEmailRequest.
type VerifyEmailResponse ¶
type VerifyEmailResponse struct {
// contains filtered or unexported fields
}
VerifyEmailResponse Email verification result. The response is one of: - `type: login` (existing organization) with JWT tokens - `type: signup` (new email) with a short-lived signup token
func (VerifyEmailResponse) AsVerifyEmailLoginResponse ¶
func (t VerifyEmailResponse) AsVerifyEmailLoginResponse() (VerifyEmailLoginResponse, error)
AsVerifyEmailLoginResponse returns the union data inside the VerifyEmailResponse as a VerifyEmailLoginResponse
func (VerifyEmailResponse) AsVerifyEmailSignupResponse ¶
func (t VerifyEmailResponse) AsVerifyEmailSignupResponse() (VerifyEmailSignupResponse, error)
AsVerifyEmailSignupResponse returns the union data inside the VerifyEmailResponse as a VerifyEmailSignupResponse
func (VerifyEmailResponse) Discriminator ¶
func (t VerifyEmailResponse) Discriminator() (string, error)
func (*VerifyEmailResponse) FromVerifyEmailLoginResponse ¶
func (t *VerifyEmailResponse) FromVerifyEmailLoginResponse(v VerifyEmailLoginResponse) error
FromVerifyEmailLoginResponse overwrites any union data inside the VerifyEmailResponse as the provided VerifyEmailLoginResponse
func (*VerifyEmailResponse) FromVerifyEmailSignupResponse ¶
func (t *VerifyEmailResponse) FromVerifyEmailSignupResponse(v VerifyEmailSignupResponse) error
FromVerifyEmailSignupResponse overwrites any union data inside the VerifyEmailResponse as the provided VerifyEmailSignupResponse
func (VerifyEmailResponse) MarshalJSON ¶
func (t VerifyEmailResponse) MarshalJSON() ([]byte, error)
func (*VerifyEmailResponse) MergeVerifyEmailLoginResponse ¶
func (t *VerifyEmailResponse) MergeVerifyEmailLoginResponse(v VerifyEmailLoginResponse) error
MergeVerifyEmailLoginResponse performs a merge with any union data inside the VerifyEmailResponse, using the provided VerifyEmailLoginResponse
func (*VerifyEmailResponse) MergeVerifyEmailSignupResponse ¶
func (t *VerifyEmailResponse) MergeVerifyEmailSignupResponse(v VerifyEmailSignupResponse) error
MergeVerifyEmailSignupResponse performs a merge with any union data inside the VerifyEmailResponse, using the provided VerifyEmailSignupResponse
func (*VerifyEmailResponse) UnmarshalJSON ¶
func (t *VerifyEmailResponse) UnmarshalJSON(b []byte) error
func (VerifyEmailResponse) ValueByDiscriminator ¶
func (t VerifyEmailResponse) ValueByDiscriminator() (interface{}, error)
type VerifyEmailSignupResponse ¶
type VerifyEmailSignupResponse struct {
Email openapi_types.Email `json:"email"`
// ExpiresIn Token expiration in seconds
ExpiresIn int `json:"expires_in"`
// SignupToken Token to complete signup (used with /api/v1/auth/signup/complete)
SignupToken string `json:"signup_token"`
Type VerifyEmailSignupResponseType `json:"type"`
}
VerifyEmailSignupResponse defines model for VerifyEmailSignupResponse.
type VerifyEmailSignupResponseType ¶
type VerifyEmailSignupResponseType string
VerifyEmailSignupResponseType defines model for VerifyEmailSignupResponse.Type.
const (
Signup VerifyEmailSignupResponseType = "signup"
)
Defines values for VerifyEmailSignupResponseType.
type WebhookResponse ¶
type WebhookResponse struct {
// JobId ID of the created job
JobId *string `json:"job_id,omitempty"`
// QueueName Name of the queue the job was enqueued to
QueueName *string `json:"queue_name,omitempty"`
// Status Job status (pending, scheduled)
Status *string `json:"status,omitempty"`
}
WebhookResponse defines model for WebhookResponse.
type WebhookTokenResponse ¶
type WebhookTokenResponse struct {
// WebhookToken The webhook token (null if cleared)
WebhookToken *string `json:"webhook_token"`
// WebhookUrl The webhook URL for this organization
WebhookUrl string `json:"webhook_url"`
}
WebhookTokenResponse defines model for WebhookTokenResponse.
type WebsocketHandlerParams ¶
type WebsocketHandlerParams struct {
// Token JWT authentication token
Token string `form:"token" json:"token"`
Queue *string `form:"queue,omitempty" json:"queue,omitempty"`
JobId *string `form:"job_id,omitempty" json:"job_id,omitempty"`
// Events Comma-separated event types
Events *string `form:"events,omitempty" json:"events,omitempty"`
}
WebsocketHandlerParams defines parameters for WebsocketHandler.
type Worker ¶
type Worker struct {
CurrentJobs int `json:"current_jobs"`
Hostname string `json:"hostname"`
Id string `json:"id"`
LastHeartbeat time.Time `json:"last_heartbeat"`
MaxConcurrency int `json:"max_concurrency"`
Metadata map[string]interface{} `json:"metadata"`
OrganizationId string `json:"organization_id"`
QueueName string `json:"queue_name"`
RegisteredAt time.Time `json:"registered_at"`
Status WorkerStatus `json:"status"`
Version *string `json:"version,omitempty"`
WorkerType *string `json:"worker_type,omitempty"`
}
Worker defines model for Worker.
type WorkerHealthSummary ¶
type WorkerHealthSummary struct {
Healthy int `json:"healthy"`
Total int `json:"total"`
Unhealthy int `json:"unhealthy"`
}
WorkerHealthSummary defines model for WorkerHealthSummary.
type WorkerHeartbeatJSONRequestBody ¶
type WorkerHeartbeatJSONRequestBody = WorkerHeartbeatRequest
WorkerHeartbeatJSONRequestBody defines body for WorkerHeartbeat for application/json ContentType.
type WorkerHeartbeatRequest ¶
type WorkerHeartbeatRequest struct {
CurrentJobs int `json:"current_jobs"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
Status *string `json:"status,omitempty"`
}
WorkerHeartbeatRequest defines model for WorkerHeartbeatRequest.
type WorkerStatus ¶
type WorkerStatus string
WorkerStatus defines model for Worker.Status.
const ( WorkerStatusDegraded WorkerStatus = "degraded" WorkerStatusDraining WorkerStatus = "draining" WorkerStatusHealthy WorkerStatus = "healthy" WorkerStatusOffline WorkerStatus = "offline" )
Defines values for WorkerStatus.
type WorkerSummary ¶
type WorkerSummary struct {
CurrentJobs int `json:"current_jobs"`
Hostname string `json:"hostname"`
Id string `json:"id"`
LastHeartbeat time.Time `json:"last_heartbeat"`
MaxConcurrency int `json:"max_concurrency"`
QueueName string `json:"queue_name"`
Status string `json:"status"`
}
WorkerSummary defines model for WorkerSummary.
type WorkflowJobDefinition ¶
type WorkflowJobDefinition struct {
DependencyMode *WorkflowJobDefinitionDependencyMode `json:"dependency_mode,omitempty"`
// DependsOn Keys of jobs this job depends on
DependsOn *[]string `json:"depends_on,omitempty"`
// Key Unique key for this job within the workflow
Key string `json:"key"`
MaxRetries *int `json:"max_retries,omitempty"`
Payload map[string]interface{} `json:"payload"`
Priority *int `json:"priority,omitempty"`
QueueName string `json:"queue_name"`
TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
}
WorkflowJobDefinition defines model for WorkflowJobDefinition.
type WorkflowJobDefinitionDependencyMode ¶
type WorkflowJobDefinitionDependencyMode string
WorkflowJobDefinitionDependencyMode defines model for WorkflowJobDefinition.DependencyMode.
const ( WorkflowJobDefinitionDependencyModeAll WorkflowJobDefinitionDependencyMode = "all" WorkflowJobDefinitionDependencyModeAny WorkflowJobDefinitionDependencyMode = "any" )
Defines values for WorkflowJobDefinitionDependencyMode.
type WorkflowJobMapping ¶
type WorkflowJobMapping struct {
JobId openapi_types.UUID `json:"job_id"`
Key string `json:"key"`
}
WorkflowJobMapping defines model for WorkflowJobMapping.
type WorkflowResponse ¶
type WorkflowResponse struct {
CompletedAt *time.Time `json:"completed_at,omitempty"`
CompletedJobs int `json:"completed_jobs"`
CreatedAt time.Time `json:"created_at"`
Description *string `json:"description,omitempty"`
FailedJobs int `json:"failed_jobs"`
Id openapi_types.UUID `json:"id"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
Name string `json:"name"`
ProgressPercent float32 `json:"progress_percent"`
StartedAt *time.Time `json:"started_at,omitempty"`
Status WorkflowResponseStatus `json:"status"`
TotalJobs int `json:"total_jobs"`
}
WorkflowResponse defines model for WorkflowResponse.
type WorkflowResponseStatus ¶
type WorkflowResponseStatus string
WorkflowResponseStatus defines model for WorkflowResponse.Status.
const ( WorkflowResponseStatusCancelled WorkflowResponseStatus = "cancelled" WorkflowResponseStatusCompleted WorkflowResponseStatus = "completed" WorkflowResponseStatusFailed WorkflowResponseStatus = "failed" WorkflowResponseStatusPending WorkflowResponseStatus = "pending" WorkflowResponseStatusRunning WorkflowResponseStatus = "running" )
Defines values for WorkflowResponseStatus.