hatchet-sdk 0.0.1 → 0.1.0.pre.alpha
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -2
- data/CLAUDE.md +20 -0
- data/INTEGRATION_TESTING.md +176 -0
- data/LICENSE.txt +1 -1
- data/REST_API_GENERATION.md +257 -0
- data/Rakefile +9 -0
- data/Rakefile.rest +133 -0
- data/config/openapi_generator_config.json +31 -0
- data/lib/hatchet/clients/rest/.gitignore +39 -0
- data/lib/hatchet/clients/rest/.gitlab-ci.yml +26 -0
- data/lib/hatchet/clients/rest/.openapi-generator/FILES +420 -0
- data/lib/hatchet/clients/rest/.openapi-generator/VERSION +1 -0
- data/lib/hatchet/clients/rest/.openapi-generator-ignore +23 -0
- data/lib/hatchet/clients/rest/.rspec +2 -0
- data/lib/hatchet/clients/rest/.rubocop.yml +148 -0
- data/lib/hatchet/clients/rest/.travis.yml +11 -0
- data/lib/hatchet/clients/rest/Gemfile +9 -0
- data/lib/hatchet/clients/rest/README.md +420 -0
- data/lib/hatchet/clients/rest/Rakefile +10 -0
- data/lib/hatchet/clients/rest/docs/APIError.md +24 -0
- data/lib/hatchet/clients/rest/docs/APIErrors.md +18 -0
- data/lib/hatchet/clients/rest/docs/APIMeta.md +30 -0
- data/lib/hatchet/clients/rest/docs/APIMetaAuth.md +18 -0
- data/lib/hatchet/clients/rest/docs/APIMetaIntegration.md +20 -0
- data/lib/hatchet/clients/rest/docs/APIMetaPosthog.md +20 -0
- data/lib/hatchet/clients/rest/docs/APIResourceMeta.md +22 -0
- data/lib/hatchet/clients/rest/docs/APIToken.md +22 -0
- data/lib/hatchet/clients/rest/docs/APITokenApi.md +235 -0
- data/lib/hatchet/clients/rest/docs/AcceptInviteRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/BulkCreateEventRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/CancelEventRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/ConcurrencyLimitStrategy.md +15 -0
- data/lib/hatchet/clients/rest/docs/CreateAPITokenRequest.md +20 -0
- data/lib/hatchet/clients/rest/docs/CreateAPITokenResponse.md +18 -0
- data/lib/hatchet/clients/rest/docs/CreateCronWorkflowTriggerRequest.md +26 -0
- data/lib/hatchet/clients/rest/docs/CreateEventRequest.md +26 -0
- data/lib/hatchet/clients/rest/docs/CreatePullRequestFromStepRun.md +18 -0
- data/lib/hatchet/clients/rest/docs/CreateSNSIntegrationRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/CreateTenantAlertEmailGroupRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/CreateTenantInviteRequest.md +20 -0
- data/lib/hatchet/clients/rest/docs/CreateTenantRequest.md +24 -0
- data/lib/hatchet/clients/rest/docs/CronWorkflows.md +40 -0
- data/lib/hatchet/clients/rest/docs/CronWorkflowsList.md +20 -0
- data/lib/hatchet/clients/rest/docs/CronWorkflowsMethod.md +15 -0
- data/lib/hatchet/clients/rest/docs/CronWorkflowsOrderByField.md +15 -0
- data/lib/hatchet/clients/rest/docs/DefaultApi.md +602 -0
- data/lib/hatchet/clients/rest/docs/Event.md +28 -0
- data/lib/hatchet/clients/rest/docs/EventApi.md +809 -0
- data/lib/hatchet/clients/rest/docs/EventData.md +18 -0
- data/lib/hatchet/clients/rest/docs/EventKeyList.md +20 -0
- data/lib/hatchet/clients/rest/docs/EventList.md +20 -0
- data/lib/hatchet/clients/rest/docs/EventOrderByDirection.md +15 -0
- data/lib/hatchet/clients/rest/docs/EventOrderByField.md +15 -0
- data/lib/hatchet/clients/rest/docs/EventUpdateCancel200Response.md +18 -0
- data/lib/hatchet/clients/rest/docs/EventWorkflowRunSummary.md +28 -0
- data/lib/hatchet/clients/rest/docs/Events.md +20 -0
- data/lib/hatchet/clients/rest/docs/FilterApi.md +402 -0
- data/lib/hatchet/clients/rest/docs/GetStepRunDiffResponse.md +18 -0
- data/lib/hatchet/clients/rest/docs/GithubApi.md +73 -0
- data/lib/hatchet/clients/rest/docs/HealthcheckApi.md +129 -0
- data/lib/hatchet/clients/rest/docs/InfoGetVersion200Response.md +18 -0
- data/lib/hatchet/clients/rest/docs/Job.md +30 -0
- data/lib/hatchet/clients/rest/docs/JobRun.md +48 -0
- data/lib/hatchet/clients/rest/docs/JobRunStatus.md +15 -0
- data/lib/hatchet/clients/rest/docs/ListAPITokensResponse.md +20 -0
- data/lib/hatchet/clients/rest/docs/ListPullRequestsResponse.md +18 -0
- data/lib/hatchet/clients/rest/docs/ListSNSIntegrations.md +20 -0
- data/lib/hatchet/clients/rest/docs/ListSlackWebhooks.md +20 -0
- data/lib/hatchet/clients/rest/docs/LogApi.md +171 -0
- data/lib/hatchet/clients/rest/docs/LogLine.md +22 -0
- data/lib/hatchet/clients/rest/docs/LogLineLevel.md +15 -0
- data/lib/hatchet/clients/rest/docs/LogLineList.md +20 -0
- data/lib/hatchet/clients/rest/docs/LogLineOrderByDirection.md +15 -0
- data/lib/hatchet/clients/rest/docs/LogLineOrderByField.md +15 -0
- data/lib/hatchet/clients/rest/docs/MetadataApi.md +203 -0
- data/lib/hatchet/clients/rest/docs/PaginationResponse.md +22 -0
- data/lib/hatchet/clients/rest/docs/PullRequest.md +32 -0
- data/lib/hatchet/clients/rest/docs/PullRequestState.md +15 -0
- data/lib/hatchet/clients/rest/docs/QueueMetrics.md +22 -0
- data/lib/hatchet/clients/rest/docs/RateLimit.md +28 -0
- data/lib/hatchet/clients/rest/docs/RateLimitList.md +20 -0
- data/lib/hatchet/clients/rest/docs/RateLimitOrderByDirection.md +15 -0
- data/lib/hatchet/clients/rest/docs/RateLimitOrderByField.md +15 -0
- data/lib/hatchet/clients/rest/docs/RateLimitsApi.md +94 -0
- data/lib/hatchet/clients/rest/docs/RecentStepRuns.md +30 -0
- data/lib/hatchet/clients/rest/docs/RejectInviteRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/ReplayEventRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/ReplayWorkflowRunsRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/ReplayWorkflowRunsResponse.md +18 -0
- data/lib/hatchet/clients/rest/docs/RerunStepRunRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/SNSApi.md +235 -0
- data/lib/hatchet/clients/rest/docs/SNSIntegration.md +24 -0
- data/lib/hatchet/clients/rest/docs/ScheduleWorkflowRunRequest.md +24 -0
- data/lib/hatchet/clients/rest/docs/ScheduledRunStatus.md +15 -0
- data/lib/hatchet/clients/rest/docs/ScheduledWorkflows.md +44 -0
- data/lib/hatchet/clients/rest/docs/ScheduledWorkflowsList.md +20 -0
- data/lib/hatchet/clients/rest/docs/ScheduledWorkflowsMethod.md +15 -0
- data/lib/hatchet/clients/rest/docs/ScheduledWorkflowsOrderByField.md +15 -0
- data/lib/hatchet/clients/rest/docs/SemaphoreSlots.md +28 -0
- data/lib/hatchet/clients/rest/docs/SlackApi.md +156 -0
- data/lib/hatchet/clients/rest/docs/SlackWebhook.md +28 -0
- data/lib/hatchet/clients/rest/docs/Step.md +32 -0
- data/lib/hatchet/clients/rest/docs/StepRun.md +68 -0
- data/lib/hatchet/clients/rest/docs/StepRunApi.md +560 -0
- data/lib/hatchet/clients/rest/docs/StepRunArchive.md +50 -0
- data/lib/hatchet/clients/rest/docs/StepRunArchiveList.md +20 -0
- data/lib/hatchet/clients/rest/docs/StepRunDiff.md +22 -0
- data/lib/hatchet/clients/rest/docs/StepRunEvent.md +36 -0
- data/lib/hatchet/clients/rest/docs/StepRunEventList.md +20 -0
- data/lib/hatchet/clients/rest/docs/StepRunEventReason.md +15 -0
- data/lib/hatchet/clients/rest/docs/StepRunEventSeverity.md +15 -0
- data/lib/hatchet/clients/rest/docs/StepRunStatus.md +15 -0
- data/lib/hatchet/clients/rest/docs/TaskApi.md +566 -0
- data/lib/hatchet/clients/rest/docs/Tenant.md +30 -0
- data/lib/hatchet/clients/rest/docs/TenantAlertEmailGroup.md +20 -0
- data/lib/hatchet/clients/rest/docs/TenantAlertEmailGroupList.md +20 -0
- data/lib/hatchet/clients/rest/docs/TenantAlertingSettings.md +30 -0
- data/lib/hatchet/clients/rest/docs/TenantApi.md +1362 -0
- data/lib/hatchet/clients/rest/docs/TenantInvite.md +28 -0
- data/lib/hatchet/clients/rest/docs/TenantInviteList.md +20 -0
- data/lib/hatchet/clients/rest/docs/TenantList.md +20 -0
- data/lib/hatchet/clients/rest/docs/TenantMember.md +24 -0
- data/lib/hatchet/clients/rest/docs/TenantMemberList.md +20 -0
- data/lib/hatchet/clients/rest/docs/TenantMemberRole.md +15 -0
- data/lib/hatchet/clients/rest/docs/TenantQueueMetrics.md +22 -0
- data/lib/hatchet/clients/rest/docs/TenantResource.md +15 -0
- data/lib/hatchet/clients/rest/docs/TenantResourceLimit.md +30 -0
- data/lib/hatchet/clients/rest/docs/TenantResourcePolicy.md +18 -0
- data/lib/hatchet/clients/rest/docs/TenantStepRunQueueMetrics.md +18 -0
- data/lib/hatchet/clients/rest/docs/TenantUIVersion.md +15 -0
- data/lib/hatchet/clients/rest/docs/TenantVersion.md +15 -0
- data/lib/hatchet/clients/rest/docs/TriggerWorkflowRunRequest.md +20 -0
- data/lib/hatchet/clients/rest/docs/UpdateTenantAlertEmailGroupRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/UpdateTenantInviteRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/UpdateTenantRequest.md +34 -0
- data/lib/hatchet/clients/rest/docs/UpdateWorkerRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/User.md +28 -0
- data/lib/hatchet/clients/rest/docs/UserApi.md +805 -0
- data/lib/hatchet/clients/rest/docs/UserChangePasswordRequest.md +20 -0
- data/lib/hatchet/clients/rest/docs/UserLoginRequest.md +20 -0
- data/lib/hatchet/clients/rest/docs/UserRegisterRequest.md +22 -0
- data/lib/hatchet/clients/rest/docs/UserTenantMembershipsList.md +20 -0
- data/lib/hatchet/clients/rest/docs/UserTenantPublic.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1CancelTaskRequest.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1CancelledTasks.md +18 -0
- data/lib/hatchet/clients/rest/docs/V1CreateFilterRequest.md +24 -0
- data/lib/hatchet/clients/rest/docs/V1DagChildren.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1Event.md +36 -0
- data/lib/hatchet/clients/rest/docs/V1EventList.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1EventTriggeredRun.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1EventWorkflowRunSummary.md +26 -0
- data/lib/hatchet/clients/rest/docs/V1Filter.md +28 -0
- data/lib/hatchet/clients/rest/docs/V1FilterList.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1LogLine.md +28 -0
- data/lib/hatchet/clients/rest/docs/V1LogLineLevel.md +15 -0
- data/lib/hatchet/clients/rest/docs/V1LogLineList.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1ReplayTaskRequest.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1ReplayedTasks.md +18 -0
- data/lib/hatchet/clients/rest/docs/V1TaskEvent.md +38 -0
- data/lib/hatchet/clients/rest/docs/V1TaskEventList.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1TaskEventType.md +15 -0
- data/lib/hatchet/clients/rest/docs/V1TaskFilter.md +26 -0
- data/lib/hatchet/clients/rest/docs/V1TaskPointMetric.md +22 -0
- data/lib/hatchet/clients/rest/docs/V1TaskPointMetrics.md +18 -0
- data/lib/hatchet/clients/rest/docs/V1TaskRunMetric.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1TaskRunStatus.md +15 -0
- data/lib/hatchet/clients/rest/docs/V1TaskStatus.md +15 -0
- data/lib/hatchet/clients/rest/docs/V1TaskSummary.md +72 -0
- data/lib/hatchet/clients/rest/docs/V1TaskSummaryList.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1TaskTiming.md +46 -0
- data/lib/hatchet/clients/rest/docs/V1TaskTimingList.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1TriggerWorkflowRunRequest.md +24 -0
- data/lib/hatchet/clients/rest/docs/V1UpdateFilterRequest.md +22 -0
- data/lib/hatchet/clients/rest/docs/V1WorkflowRun.md +46 -0
- data/lib/hatchet/clients/rest/docs/V1WorkflowRunDetails.md +26 -0
- data/lib/hatchet/clients/rest/docs/V1WorkflowRunDisplayName.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1WorkflowRunDisplayNameList.md +20 -0
- data/lib/hatchet/clients/rest/docs/V1WorkflowType.md +15 -0
- data/lib/hatchet/clients/rest/docs/WebhookWorker.md +22 -0
- data/lib/hatchet/clients/rest/docs/WebhookWorkerCreateRequest.md +22 -0
- data/lib/hatchet/clients/rest/docs/WebhookWorkerCreateResponse.md +18 -0
- data/lib/hatchet/clients/rest/docs/WebhookWorkerCreated.md +24 -0
- data/lib/hatchet/clients/rest/docs/WebhookWorkerListResponse.md +20 -0
- data/lib/hatchet/clients/rest/docs/WebhookWorkerRequest.md +22 -0
- data/lib/hatchet/clients/rest/docs/WebhookWorkerRequestListResponse.md +18 -0
- data/lib/hatchet/clients/rest/docs/WebhookWorkerRequestMethod.md +15 -0
- data/lib/hatchet/clients/rest/docs/Worker.md +48 -0
- data/lib/hatchet/clients/rest/docs/WorkerApi.md +234 -0
- data/lib/hatchet/clients/rest/docs/WorkerLabel.md +22 -0
- data/lib/hatchet/clients/rest/docs/WorkerList.md +20 -0
- data/lib/hatchet/clients/rest/docs/WorkerRuntimeInfo.md +26 -0
- data/lib/hatchet/clients/rest/docs/WorkerRuntimeSDKs.md +15 -0
- data/lib/hatchet/clients/rest/docs/WorkerType.md +15 -0
- data/lib/hatchet/clients/rest/docs/Workflow.md +32 -0
- data/lib/hatchet/clients/rest/docs/WorkflowApi.md +1480 -0
- data/lib/hatchet/clients/rest/docs/WorkflowConcurrency.md +22 -0
- data/lib/hatchet/clients/rest/docs/WorkflowKind.md +15 -0
- data/lib/hatchet/clients/rest/docs/WorkflowList.md +22 -0
- data/lib/hatchet/clients/rest/docs/WorkflowMetrics.md +20 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRun.md +48 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunApi.md +477 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunList.md +20 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunOrderByDirection.md +15 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunOrderByField.md +15 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunShape.md +50 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunShapeItemForWorkflowRunDetails.md +24 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunStatus.md +15 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunTriggeredBy.md +26 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunsApi.md +572 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunsCancelRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunsMetrics.md +18 -0
- data/lib/hatchet/clients/rest/docs/WorkflowRunsMetricsCounts.md +28 -0
- data/lib/hatchet/clients/rest/docs/WorkflowTag.md +20 -0
- data/lib/hatchet/clients/rest/docs/WorkflowTriggerCronRef.md +20 -0
- data/lib/hatchet/clients/rest/docs/WorkflowTriggerEventRef.md +20 -0
- data/lib/hatchet/clients/rest/docs/WorkflowTriggers.md +26 -0
- data/lib/hatchet/clients/rest/docs/WorkflowUpdateRequest.md +18 -0
- data/lib/hatchet/clients/rest/docs/WorkflowVersion.md +40 -0
- data/lib/hatchet/clients/rest/docs/WorkflowVersionDefinition.md +18 -0
- data/lib/hatchet/clients/rest/docs/WorkflowVersionMeta.md +26 -0
- data/lib/hatchet/clients/rest/docs/WorkflowWorkersCount.md +22 -0
- data/lib/hatchet/clients/rest/git_push.sh +57 -0
- data/lib/hatchet/clients/rest/hatchet-sdk-rest.gemspec +41 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/api_token_api.rb +242 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/default_api.rb +622 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/event_api.rb +836 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/filter_api.rb +449 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/github_api.rb +107 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/healthcheck_api.rb +132 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/log_api.rb +182 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/metadata_api.rb +193 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/rate_limits_api.rb +108 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/slack_api.rb +164 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/sns_api.rb +242 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/step_run_api.rb +615 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/task_api.rb +599 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/tenant_api.rb +1327 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/user_api.rb +729 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/worker_api.rb +246 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb +1654 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_run_api.rb +540 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_runs_api.rb +614 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api_client.rb +437 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api_error.rb +58 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/configuration.rb +399 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/accept_invite_request.rb +255 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/api_error.rb +268 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/api_errors.rb +239 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/api_meta.rb +279 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/api_meta_auth.rb +223 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/api_meta_integration.rb +265 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/api_meta_posthog.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/api_resource_meta.rb +310 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/api_token.rb +300 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/bulk_create_event_request.rb +239 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/cancel_event_request.rb +239 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/concurrency_limit_strategy.rb +42 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/create_api_token_request.rb +257 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/create_api_token_response.rb +238 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/create_cron_workflow_trigger_request.rb +352 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/create_event_request.rb +295 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/create_pull_request_from_step_run.rb +237 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/create_sns_integration_request.rb +238 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/create_tenant_alert_email_group_request.rb +240 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/create_tenant_invite_request.rb +287 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/create_tenant_request.rb +307 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/cron_workflows.rb +509 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/cron_workflows_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/cron_workflows_method.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/cron_workflows_order_by_field.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/event.rb +321 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/event_data.rb +238 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/event_key_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/event_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/event_order_by_direction.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/event_order_by_field.rb +39 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/event_update_cancel200_response.rb +222 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/event_workflow_run_summary.rb +271 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/events.rb +266 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/get_step_run_diff_response.rb +239 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/info_get_version200_response.rb +237 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/job.rb +363 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/job_run.rb +464 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/job_run_status.rb +44 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/list_api_tokens_response.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/list_pull_requests_response.rb +239 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/list_slack_webhooks.rb +265 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/list_sns_integrations.rb +265 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/log_line.rb +292 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/log_line_level.rb +42 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/log_line_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/log_line_order_by_direction.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/log_line_order_by_field.rb +39 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/pagination_response.rb +241 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/pull_request.rb +441 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/pull_request_state.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/queue_metrics.rb +292 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/rate_limit.rb +373 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/rate_limit_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/rate_limit_order_by_direction.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/rate_limit_order_by_field.rb +41 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/recent_step_runs.rb +365 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/reject_invite_request.rb +255 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/replay_event_request.rb +239 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/replay_workflow_runs_request.rb +239 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/replay_workflow_runs_response.rb +239 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/rerun_step_run_request.rb +237 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/schedule_workflow_run_request.rb +326 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/scheduled_run_status.rb +45 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/scheduled_workflows.rb +538 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/scheduled_workflows_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/scheduled_workflows_method.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/scheduled_workflows_order_by_field.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/semaphore_slots.rb +343 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/slack_webhook.rb +372 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/sns_integration.rb +301 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step.rb +374 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step_run.rb +556 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step_run_archive.rb +432 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step_run_archive_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step_run_diff.rb +289 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step_run_event.rb +442 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step_run_event_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step_run_event_reason.rb +55 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step_run_event_severity.rb +41 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/step_run_status.rb +47 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant.rb +370 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_alert_email_group.rb +266 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_alert_email_group_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_alerting_settings.rb +314 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_invite.rb +377 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_invite_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_member.rb +323 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_member_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_member_role.rb +41 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_queue_metrics.rb +243 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_resource.rb +45 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_resource_limit.rb +370 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_resource_policy.rb +240 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_step_run_queue_metrics.rb +220 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_ui_version.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/tenant_version.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/trigger_workflow_run_request.rb +246 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/update_tenant_alert_email_group_request.rb +240 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/update_tenant_invite_request.rb +260 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/update_tenant_request.rb +323 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/update_worker_request.rb +221 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/user.rb +321 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/user_change_password_request.rb +265 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/user_login_request.rb +265 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/user_register_request.rb +292 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/user_tenant_memberships_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/user_tenant_public.rb +248 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_cancel_task_request.rb +232 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_cancelled_tasks.rb +223 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_create_filter_request.rb +320 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_dag_children.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_event.rb +380 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_event_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_event_triggered_run.rb +266 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_event_workflow_run_summary.rb +346 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_filter.rb +390 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_filter_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_log_line.rb +344 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_log_line_level.rb +42 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_log_line_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_replay_task_request.rb +232 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_replayed_tasks.rb +223 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_event.rb +419 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_event_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_event_type.rb +58 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_filter.rb +279 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_point_metric.rb +289 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_point_metrics.rb +222 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_run_metric.rb +285 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_run_status.rb +43 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_status.rb +43 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_summary.rb +812 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_summary_list.rb +266 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_timing.rb +581 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_task_timing_list.rb +266 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_trigger_workflow_run_request.rb +283 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_update_filter_request.rb +241 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_workflow_run.rb +544 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_workflow_run_details.rb +331 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_workflow_run_display_name.rb +263 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_workflow_run_display_name_list.rb +266 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/v1_workflow_type.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/webhook_worker.rb +291 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/webhook_worker_create_request.rb +294 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/webhook_worker_create_response.rb +220 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/webhook_worker_created.rb +318 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/webhook_worker_list_response.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/webhook_worker_request.rb +314 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/webhook_worker_request_list_response.rb +223 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/webhook_worker_request_method.rb +41 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/worker.rb +489 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/worker_label.rb +274 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/worker_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/worker_runtime_info.rb +278 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/worker_runtime_sdks.rb +41 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/worker_type.rb +41 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow.rb +346 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_concurrency.rb +314 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_kind.rb +41 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_list.rb +240 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_metrics.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_run.rb +524 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_run_list.rb +231 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_run_order_by_direction.rb +40 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_run_order_by_field.rb +42 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_run_shape.rb +533 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_run_shape_item_for_workflow_run_details.rb +353 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_run_status.rb +45 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_run_triggered_by.rb +273 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_runs_cancel_request.rb +239 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_runs_metrics.rb +220 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_runs_metrics_counts.rb +265 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_tag.rb +265 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_trigger_cron_ref.rb +229 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_trigger_event_ref.rb +229 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_triggers.rb +260 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_update_request.rb +221 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_version.rb +392 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_version_definition.rb +238 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_version_meta.rb +325 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/workflow_workers_count.rb +238 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/version.rb +15 -0
- data/lib/hatchet/clients/rest/lib/hatchet-sdk-rest.rb +241 -0
- data/lib/hatchet/clients/rest/spec/spec_helper.rb +111 -0
- data/lib/hatchet/clients/rest.rb +126 -0
- data/lib/hatchet/clients.rb +71 -0
- data/lib/hatchet/config.rb +7 -7
- data/lib/hatchet/features/events.rb +265 -0
- data/lib/hatchet/features/runs.rb +423 -0
- data/lib/hatchet/version.rb +1 -1
- data/lib/hatchet-sdk.rb +21 -0
- data/scripts/generate.sh +167 -0
- data/scripts/generate_api.rb +174 -0
- data/sig/hatchet-sdk.rbs +425 -3
- metadata +490 -1
|
@@ -0,0 +1,420 @@
|
|
|
1
|
+
# hatchet-sdk-rest
|
|
2
|
+
|
|
3
|
+
HatchetSdkRest - the Ruby gem for the Hatchet API
|
|
4
|
+
|
|
5
|
+
The Hatchet API
|
|
6
|
+
|
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
|
+
|
|
9
|
+
- API version: 1.0.0
|
|
10
|
+
- Package version: 0.0.1
|
|
11
|
+
- Generator version: 7.14.0
|
|
12
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
### Build a gem
|
|
17
|
+
|
|
18
|
+
To build the Ruby code into a gem:
|
|
19
|
+
|
|
20
|
+
```shell
|
|
21
|
+
gem build hatchet-sdk-rest.gemspec
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Then either install the gem locally:
|
|
25
|
+
|
|
26
|
+
```shell
|
|
27
|
+
gem install ./hatchet-sdk-rest-0.0.1.gem
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
(for development, run `gem install --dev ./hatchet-sdk-rest-0.0.1.gem` to install the development dependencies)
|
|
31
|
+
|
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
|
+
|
|
34
|
+
Finally add this to the Gemfile:
|
|
35
|
+
|
|
36
|
+
gem 'hatchet-sdk-rest', '~> 0.0.1'
|
|
37
|
+
|
|
38
|
+
### Install from Git
|
|
39
|
+
|
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
|
41
|
+
|
|
42
|
+
gem 'hatchet-sdk-rest', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
|
43
|
+
|
|
44
|
+
### Include the Ruby code directly
|
|
45
|
+
|
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
|
47
|
+
|
|
48
|
+
```shell
|
|
49
|
+
ruby -Ilib script.rb
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Getting Started
|
|
53
|
+
|
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
# Load the gem
|
|
58
|
+
require 'hatchet-sdk-rest'
|
|
59
|
+
|
|
60
|
+
# Setup authorization
|
|
61
|
+
HatchetSdkRest.configure do |config|
|
|
62
|
+
# Configure API key authorization: cookieAuth
|
|
63
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
64
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
65
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
66
|
+
# Configure faraday connection
|
|
67
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
|
68
|
+
|
|
69
|
+
# Configure Bearer authorization: bearerAuth
|
|
70
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
71
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
|
72
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
|
|
73
|
+
# Configure faraday connection
|
|
74
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
api_instance = HatchetSdkRest::APITokenApi.new
|
|
78
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
79
|
+
opts = {
|
|
80
|
+
create_api_token_request: HatchetSdkRest::CreateAPITokenRequest.new({name: 'name_example'}) # CreateAPITokenRequest |
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
begin
|
|
84
|
+
#Create API Token
|
|
85
|
+
result = api_instance.api_token_create(tenant, opts)
|
|
86
|
+
p result
|
|
87
|
+
rescue HatchetSdkRest::ApiError => e
|
|
88
|
+
puts "Exception when calling APITokenApi->api_token_create: #{e}"
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Documentation for API Endpoints
|
|
94
|
+
|
|
95
|
+
All URIs are relative to *http://localhost*
|
|
96
|
+
|
|
97
|
+
Class | Method | HTTP request | Description
|
|
98
|
+
------------ | ------------- | ------------- | -------------
|
|
99
|
+
*HatchetSdkRest::APITokenApi* | [**api_token_create**](docs/APITokenApi.md#api_token_create) | **POST** /api/v1/tenants/{tenant}/api-tokens | Create API Token
|
|
100
|
+
*HatchetSdkRest::APITokenApi* | [**api_token_list**](docs/APITokenApi.md#api_token_list) | **GET** /api/v1/tenants/{tenant}/api-tokens | List API Tokens
|
|
101
|
+
*HatchetSdkRest::APITokenApi* | [**api_token_update_revoke**](docs/APITokenApi.md#api_token_update_revoke) | **POST** /api/v1/api-tokens/{api-token} | Revoke API Token
|
|
102
|
+
*HatchetSdkRest::DefaultApi* | [**info_get_version**](docs/DefaultApi.md#info_get_version) | **GET** /api/v1/version | We return the version for the currently running server
|
|
103
|
+
*HatchetSdkRest::DefaultApi* | [**monitoring_post_run_probe**](docs/DefaultApi.md#monitoring_post_run_probe) | **POST** /api/v1/monitoring/{tenant}/probe | Detailed Health Probe For the Instance
|
|
104
|
+
*HatchetSdkRest::DefaultApi* | [**tenant_invite_delete**](docs/DefaultApi.md#tenant_invite_delete) | **DELETE** /api/v1/tenants/{tenant}/invites/{tenant-invite} | Delete invite
|
|
105
|
+
*HatchetSdkRest::DefaultApi* | [**tenant_invite_update**](docs/DefaultApi.md#tenant_invite_update) | **PATCH** /api/v1/tenants/{tenant}/invites/{tenant-invite} | Update invite
|
|
106
|
+
*HatchetSdkRest::DefaultApi* | [**webhook_create**](docs/DefaultApi.md#webhook_create) | **POST** /api/v1/tenants/{tenant}/webhook-workers | Create a webhook
|
|
107
|
+
*HatchetSdkRest::DefaultApi* | [**webhook_delete**](docs/DefaultApi.md#webhook_delete) | **DELETE** /api/v1/webhook-workers/{webhook} | Delete a webhook
|
|
108
|
+
*HatchetSdkRest::DefaultApi* | [**webhook_list**](docs/DefaultApi.md#webhook_list) | **GET** /api/v1/tenants/{tenant}/webhook-workers | List webhooks
|
|
109
|
+
*HatchetSdkRest::DefaultApi* | [**webhook_requests_list**](docs/DefaultApi.md#webhook_requests_list) | **GET** /api/v1/webhook-workers/{webhook}/requests | List webhook requests
|
|
110
|
+
*HatchetSdkRest::EventApi* | [**event_create**](docs/EventApi.md#event_create) | **POST** /api/v1/tenants/{tenant}/events | Create event
|
|
111
|
+
*HatchetSdkRest::EventApi* | [**event_create_bulk**](docs/EventApi.md#event_create_bulk) | **POST** /api/v1/tenants/{tenant}/events/bulk | Bulk Create events
|
|
112
|
+
*HatchetSdkRest::EventApi* | [**event_data_get**](docs/EventApi.md#event_data_get) | **GET** /api/v1/events/{event}/data | Get event data
|
|
113
|
+
*HatchetSdkRest::EventApi* | [**event_get**](docs/EventApi.md#event_get) | **GET** /api/v1/events/{event} | Get event data
|
|
114
|
+
*HatchetSdkRest::EventApi* | [**event_key_list**](docs/EventApi.md#event_key_list) | **GET** /api/v1/tenants/{tenant}/events/keys | List event keys
|
|
115
|
+
*HatchetSdkRest::EventApi* | [**event_list**](docs/EventApi.md#event_list) | **GET** /api/v1/tenants/{tenant}/events | List events
|
|
116
|
+
*HatchetSdkRest::EventApi* | [**event_update_cancel**](docs/EventApi.md#event_update_cancel) | **POST** /api/v1/tenants/{tenant}/events/cancel | Replay events
|
|
117
|
+
*HatchetSdkRest::EventApi* | [**event_update_replay**](docs/EventApi.md#event_update_replay) | **POST** /api/v1/tenants/{tenant}/events/replay | Replay events
|
|
118
|
+
*HatchetSdkRest::EventApi* | [**v1_event_key_list**](docs/EventApi.md#v1_event_key_list) | **GET** /api/v1/stable/tenants/{tenant}/events/keys | List event keys
|
|
119
|
+
*HatchetSdkRest::EventApi* | [**v1_event_list**](docs/EventApi.md#v1_event_list) | **GET** /api/v1/stable/tenants/{tenant}/events | List events
|
|
120
|
+
*HatchetSdkRest::FilterApi* | [**v1_filter_create**](docs/FilterApi.md#v1_filter_create) | **POST** /api/v1/stable/tenants/{tenant}/filters | Create a filter
|
|
121
|
+
*HatchetSdkRest::FilterApi* | [**v1_filter_delete**](docs/FilterApi.md#v1_filter_delete) | **DELETE** /api/v1/stable/tenants/{tenant}/filters/{v1-filter} |
|
|
122
|
+
*HatchetSdkRest::FilterApi* | [**v1_filter_get**](docs/FilterApi.md#v1_filter_get) | **GET** /api/v1/stable/tenants/{tenant}/filters/{v1-filter} | Get a filter
|
|
123
|
+
*HatchetSdkRest::FilterApi* | [**v1_filter_list**](docs/FilterApi.md#v1_filter_list) | **GET** /api/v1/stable/tenants/{tenant}/filters | List filters
|
|
124
|
+
*HatchetSdkRest::FilterApi* | [**v1_filter_update**](docs/FilterApi.md#v1_filter_update) | **PATCH** /api/v1/stable/tenants/{tenant}/filters/{v1-filter} |
|
|
125
|
+
*HatchetSdkRest::GithubApi* | [**sns_update**](docs/GithubApi.md#sns_update) | **POST** /api/v1/sns/{tenant}/{event} | Github app tenant webhook
|
|
126
|
+
*HatchetSdkRest::HealthcheckApi* | [**liveness_get**](docs/HealthcheckApi.md#liveness_get) | **GET** /api/live | Get liveness
|
|
127
|
+
*HatchetSdkRest::HealthcheckApi* | [**readiness_get**](docs/HealthcheckApi.md#readiness_get) | **GET** /api/ready | Get readiness
|
|
128
|
+
*HatchetSdkRest::LogApi* | [**log_line_list**](docs/LogApi.md#log_line_list) | **GET** /api/v1/step-runs/{step-run}/logs | List log lines
|
|
129
|
+
*HatchetSdkRest::LogApi* | [**v1_log_line_list**](docs/LogApi.md#v1_log_line_list) | **GET** /api/v1/stable/tasks/{task}/logs | List log lines
|
|
130
|
+
*HatchetSdkRest::MetadataApi* | [**cloud_metadata_get**](docs/MetadataApi.md#cloud_metadata_get) | **GET** /api/v1/cloud/metadata | Get cloud metadata
|
|
131
|
+
*HatchetSdkRest::MetadataApi* | [**metadata_get**](docs/MetadataApi.md#metadata_get) | **GET** /api/v1/meta | Get metadata
|
|
132
|
+
*HatchetSdkRest::MetadataApi* | [**metadata_list_integrations**](docs/MetadataApi.md#metadata_list_integrations) | **GET** /api/v1/meta/integrations | List integrations
|
|
133
|
+
*HatchetSdkRest::RateLimitsApi* | [**rate_limit_list**](docs/RateLimitsApi.md#rate_limit_list) | **GET** /api/v1/tenants/{tenant}/rate-limits | List rate limits
|
|
134
|
+
*HatchetSdkRest::SNSApi* | [**sns_create**](docs/SNSApi.md#sns_create) | **POST** /api/v1/tenants/{tenant}/sns | Create SNS integration
|
|
135
|
+
*HatchetSdkRest::SNSApi* | [**sns_delete**](docs/SNSApi.md#sns_delete) | **DELETE** /api/v1/sns/{sns} | Delete SNS integration
|
|
136
|
+
*HatchetSdkRest::SNSApi* | [**sns_list**](docs/SNSApi.md#sns_list) | **GET** /api/v1/tenants/{tenant}/sns | List SNS integrations
|
|
137
|
+
*HatchetSdkRest::SlackApi* | [**slack_webhook_delete**](docs/SlackApi.md#slack_webhook_delete) | **DELETE** /api/v1/slack/{slack} | Delete Slack webhook
|
|
138
|
+
*HatchetSdkRest::SlackApi* | [**slack_webhook_list**](docs/SlackApi.md#slack_webhook_list) | **GET** /api/v1/tenants/{tenant}/slack | List Slack integrations
|
|
139
|
+
*HatchetSdkRest::StepRunApi* | [**step_run_get**](docs/StepRunApi.md#step_run_get) | **GET** /api/v1/tenants/{tenant}/step-runs/{step-run} | Get step run
|
|
140
|
+
*HatchetSdkRest::StepRunApi* | [**step_run_get_schema**](docs/StepRunApi.md#step_run_get_schema) | **GET** /api/v1/tenants/{tenant}/step-runs/{step-run}/schema | Get step run schema
|
|
141
|
+
*HatchetSdkRest::StepRunApi* | [**step_run_list_archives**](docs/StepRunApi.md#step_run_list_archives) | **GET** /api/v1/step-runs/{step-run}/archives | List archives for step run
|
|
142
|
+
*HatchetSdkRest::StepRunApi* | [**step_run_list_events**](docs/StepRunApi.md#step_run_list_events) | **GET** /api/v1/step-runs/{step-run}/events | List events for step run
|
|
143
|
+
*HatchetSdkRest::StepRunApi* | [**step_run_update_cancel**](docs/StepRunApi.md#step_run_update_cancel) | **POST** /api/v1/tenants/{tenant}/step-runs/{step-run}/cancel | Attempts to cancel a step run
|
|
144
|
+
*HatchetSdkRest::StepRunApi* | [**step_run_update_rerun**](docs/StepRunApi.md#step_run_update_rerun) | **POST** /api/v1/tenants/{tenant}/step-runs/{step-run}/rerun | Rerun step run
|
|
145
|
+
*HatchetSdkRest::StepRunApi* | [**workflow_run_list_step_run_events**](docs/StepRunApi.md#workflow_run_list_step_run_events) | **GET** /api/v1/tenants/{tenant}/workflow-runs/{workflow-run}/step-run-events | List events for all step runs for a workflow run
|
|
146
|
+
*HatchetSdkRest::TaskApi* | [**v1_dag_list_tasks**](docs/TaskApi.md#v1_dag_list_tasks) | **GET** /api/v1/stable/dags/tasks | List tasks
|
|
147
|
+
*HatchetSdkRest::TaskApi* | [**v1_task_cancel**](docs/TaskApi.md#v1_task_cancel) | **POST** /api/v1/stable/tenants/{tenant}/tasks/cancel | Cancel tasks
|
|
148
|
+
*HatchetSdkRest::TaskApi* | [**v1_task_event_list**](docs/TaskApi.md#v1_task_event_list) | **GET** /api/v1/stable/tasks/{task}/task-events | List events for a task
|
|
149
|
+
*HatchetSdkRest::TaskApi* | [**v1_task_get**](docs/TaskApi.md#v1_task_get) | **GET** /api/v1/stable/tasks/{task} | Get a task
|
|
150
|
+
*HatchetSdkRest::TaskApi* | [**v1_task_get_point_metrics**](docs/TaskApi.md#v1_task_get_point_metrics) | **GET** /api/v1/stable/tenants/{tenant}/task-point-metrics | Get task point metrics
|
|
151
|
+
*HatchetSdkRest::TaskApi* | [**v1_task_list_status_metrics**](docs/TaskApi.md#v1_task_list_status_metrics) | **GET** /api/v1/stable/tenants/{tenant}/task-metrics | Get task metrics
|
|
152
|
+
*HatchetSdkRest::TaskApi* | [**v1_task_replay**](docs/TaskApi.md#v1_task_replay) | **POST** /api/v1/stable/tenants/{tenant}/tasks/replay | Replay tasks
|
|
153
|
+
*HatchetSdkRest::TenantApi* | [**alert_email_group_create**](docs/TenantApi.md#alert_email_group_create) | **POST** /api/v1/tenants/{tenant}/alerting-email-groups | Create tenant alert email group
|
|
154
|
+
*HatchetSdkRest::TenantApi* | [**alert_email_group_delete**](docs/TenantApi.md#alert_email_group_delete) | **DELETE** /api/v1/alerting-email-groups/{alert-email-group} | Delete tenant alert email group
|
|
155
|
+
*HatchetSdkRest::TenantApi* | [**alert_email_group_list**](docs/TenantApi.md#alert_email_group_list) | **GET** /api/v1/tenants/{tenant}/alerting-email-groups | List tenant alert email groups
|
|
156
|
+
*HatchetSdkRest::TenantApi* | [**alert_email_group_update**](docs/TenantApi.md#alert_email_group_update) | **PATCH** /api/v1/alerting-email-groups/{alert-email-group} | Update tenant alert email group
|
|
157
|
+
*HatchetSdkRest::TenantApi* | [**tenant_alerting_settings_get**](docs/TenantApi.md#tenant_alerting_settings_get) | **GET** /api/v1/tenants/{tenant}/alerting/settings | Get tenant alerting settings
|
|
158
|
+
*HatchetSdkRest::TenantApi* | [**tenant_create**](docs/TenantApi.md#tenant_create) | **POST** /api/v1/tenants | Create tenant
|
|
159
|
+
*HatchetSdkRest::TenantApi* | [**tenant_get**](docs/TenantApi.md#tenant_get) | **GET** /api/v1/tenants/{tenant} | Get tenant
|
|
160
|
+
*HatchetSdkRest::TenantApi* | [**tenant_get_prometheus_metrics**](docs/TenantApi.md#tenant_get_prometheus_metrics) | **GET** /api/v1/tenants/{tenant}/prometheus-metrics | Get prometheus metrics
|
|
161
|
+
*HatchetSdkRest::TenantApi* | [**tenant_get_step_run_queue_metrics**](docs/TenantApi.md#tenant_get_step_run_queue_metrics) | **GET** /api/v1/tenants/{tenant}/step-run-queue-metrics | Get step run metrics
|
|
162
|
+
*HatchetSdkRest::TenantApi* | [**tenant_invite_accept**](docs/TenantApi.md#tenant_invite_accept) | **POST** /api/v1/users/invites/accept | Accept tenant invite
|
|
163
|
+
*HatchetSdkRest::TenantApi* | [**tenant_invite_create**](docs/TenantApi.md#tenant_invite_create) | **POST** /api/v1/tenants/{tenant}/invites | Create tenant invite
|
|
164
|
+
*HatchetSdkRest::TenantApi* | [**tenant_invite_list**](docs/TenantApi.md#tenant_invite_list) | **GET** /api/v1/tenants/{tenant}/invites | List tenant invites
|
|
165
|
+
*HatchetSdkRest::TenantApi* | [**tenant_invite_reject**](docs/TenantApi.md#tenant_invite_reject) | **POST** /api/v1/users/invites/reject | Reject tenant invite
|
|
166
|
+
*HatchetSdkRest::TenantApi* | [**tenant_member_delete**](docs/TenantApi.md#tenant_member_delete) | **DELETE** /api/v1/tenants/{tenant}/members/{member} | Delete a tenant member
|
|
167
|
+
*HatchetSdkRest::TenantApi* | [**tenant_member_list**](docs/TenantApi.md#tenant_member_list) | **GET** /api/v1/tenants/{tenant}/members | List tenant members
|
|
168
|
+
*HatchetSdkRest::TenantApi* | [**tenant_resource_policy_get**](docs/TenantApi.md#tenant_resource_policy_get) | **GET** /api/v1/tenants/{tenant}/resource-policy | Create tenant alert email group
|
|
169
|
+
*HatchetSdkRest::TenantApi* | [**tenant_update**](docs/TenantApi.md#tenant_update) | **PATCH** /api/v1/tenants/{tenant} | Update tenant
|
|
170
|
+
*HatchetSdkRest::TenantApi* | [**user_list_tenant_invites**](docs/TenantApi.md#user_list_tenant_invites) | **GET** /api/v1/users/invites | List tenant invites
|
|
171
|
+
*HatchetSdkRest::UserApi* | [**tenant_memberships_list**](docs/UserApi.md#tenant_memberships_list) | **GET** /api/v1/users/memberships | List tenant memberships
|
|
172
|
+
*HatchetSdkRest::UserApi* | [**user_create**](docs/UserApi.md#user_create) | **POST** /api/v1/users/register | Register user
|
|
173
|
+
*HatchetSdkRest::UserApi* | [**user_get_current**](docs/UserApi.md#user_get_current) | **GET** /api/v1/users/current | Get current user
|
|
174
|
+
*HatchetSdkRest::UserApi* | [**user_update_github_oauth_callback**](docs/UserApi.md#user_update_github_oauth_callback) | **GET** /api/v1/users/github/callback | Complete OAuth flow
|
|
175
|
+
*HatchetSdkRest::UserApi* | [**user_update_github_oauth_start**](docs/UserApi.md#user_update_github_oauth_start) | **GET** /api/v1/users/github/start | Start OAuth flow
|
|
176
|
+
*HatchetSdkRest::UserApi* | [**user_update_google_oauth_callback**](docs/UserApi.md#user_update_google_oauth_callback) | **GET** /api/v1/users/google/callback | Complete OAuth flow
|
|
177
|
+
*HatchetSdkRest::UserApi* | [**user_update_google_oauth_start**](docs/UserApi.md#user_update_google_oauth_start) | **GET** /api/v1/users/google/start | Start OAuth flow
|
|
178
|
+
*HatchetSdkRest::UserApi* | [**user_update_login**](docs/UserApi.md#user_update_login) | **POST** /api/v1/users/login | Login user
|
|
179
|
+
*HatchetSdkRest::UserApi* | [**user_update_logout**](docs/UserApi.md#user_update_logout) | **POST** /api/v1/users/logout | Logout user
|
|
180
|
+
*HatchetSdkRest::UserApi* | [**user_update_password**](docs/UserApi.md#user_update_password) | **POST** /api/v1/users/password | Change user password
|
|
181
|
+
*HatchetSdkRest::UserApi* | [**user_update_slack_oauth_callback**](docs/UserApi.md#user_update_slack_oauth_callback) | **GET** /api/v1/users/slack/callback | Complete OAuth flow
|
|
182
|
+
*HatchetSdkRest::UserApi* | [**user_update_slack_oauth_start**](docs/UserApi.md#user_update_slack_oauth_start) | **GET** /api/v1/tenants/{tenant}/slack/start | Start OAuth flow
|
|
183
|
+
*HatchetSdkRest::WorkerApi* | [**worker_get**](docs/WorkerApi.md#worker_get) | **GET** /api/v1/workers/{worker} | Get worker
|
|
184
|
+
*HatchetSdkRest::WorkerApi* | [**worker_list**](docs/WorkerApi.md#worker_list) | **GET** /api/v1/tenants/{tenant}/worker | Get workers
|
|
185
|
+
*HatchetSdkRest::WorkerApi* | [**worker_update**](docs/WorkerApi.md#worker_update) | **PATCH** /api/v1/workers/{worker} | Update worker
|
|
186
|
+
*HatchetSdkRest::WorkflowApi* | [**cron_workflow_list**](docs/WorkflowApi.md#cron_workflow_list) | **GET** /api/v1/tenants/{tenant}/workflows/crons | Get cron job workflows
|
|
187
|
+
*HatchetSdkRest::WorkflowApi* | [**tenant_get_queue_metrics**](docs/WorkflowApi.md#tenant_get_queue_metrics) | **GET** /api/v1/tenants/{tenant}/queue-metrics | Get workflow metrics
|
|
188
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_cron_delete**](docs/WorkflowApi.md#workflow_cron_delete) | **DELETE** /api/v1/tenants/{tenant}/workflows/crons/{cron-workflow} | Delete cron job workflow run
|
|
189
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_cron_get**](docs/WorkflowApi.md#workflow_cron_get) | **GET** /api/v1/tenants/{tenant}/workflows/crons/{cron-workflow} | Get cron job workflow run
|
|
190
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_delete**](docs/WorkflowApi.md#workflow_delete) | **DELETE** /api/v1/workflows/{workflow} | Delete workflow
|
|
191
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_get**](docs/WorkflowApi.md#workflow_get) | **GET** /api/v1/workflows/{workflow} | Get workflow
|
|
192
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_get_metrics**](docs/WorkflowApi.md#workflow_get_metrics) | **GET** /api/v1/workflows/{workflow}/metrics | Get workflow metrics
|
|
193
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_get_workers_count**](docs/WorkflowApi.md#workflow_get_workers_count) | **GET** /api/v1/tenants/{tenant}/workflows/{workflow}/worker-count | Get workflow worker count
|
|
194
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_list**](docs/WorkflowApi.md#workflow_list) | **GET** /api/v1/tenants/{tenant}/workflows | Get workflows
|
|
195
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_run_get**](docs/WorkflowApi.md#workflow_run_get) | **GET** /api/v1/tenants/{tenant}/workflow-runs/{workflow-run} | Get workflow run
|
|
196
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_run_get_metrics**](docs/WorkflowApi.md#workflow_run_get_metrics) | **GET** /api/v1/tenants/{tenant}/workflows/runs/metrics | Get workflow runs metrics
|
|
197
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_run_get_shape**](docs/WorkflowApi.md#workflow_run_get_shape) | **GET** /api/v1/tenants/{tenant}/workflow-runs/{workflow-run}/shape | Get workflow run
|
|
198
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_run_list**](docs/WorkflowApi.md#workflow_run_list) | **GET** /api/v1/tenants/{tenant}/workflows/runs | Get workflow runs
|
|
199
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_scheduled_delete**](docs/WorkflowApi.md#workflow_scheduled_delete) | **DELETE** /api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run} | Delete scheduled workflow run
|
|
200
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_scheduled_get**](docs/WorkflowApi.md#workflow_scheduled_get) | **GET** /api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run} | Get scheduled workflow run
|
|
201
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_scheduled_list**](docs/WorkflowApi.md#workflow_scheduled_list) | **GET** /api/v1/tenants/{tenant}/workflows/scheduled | Get scheduled workflow runs
|
|
202
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_update**](docs/WorkflowApi.md#workflow_update) | **PATCH** /api/v1/workflows/{workflow} | Update workflow
|
|
203
|
+
*HatchetSdkRest::WorkflowApi* | [**workflow_version_get**](docs/WorkflowApi.md#workflow_version_get) | **GET** /api/v1/workflows/{workflow}/versions | Get workflow version
|
|
204
|
+
*HatchetSdkRest::WorkflowRunApi* | [**cron_workflow_trigger_create**](docs/WorkflowRunApi.md#cron_workflow_trigger_create) | **POST** /api/v1/tenants/{tenant}/workflows/{workflow}/crons | Create cron job workflow trigger
|
|
205
|
+
*HatchetSdkRest::WorkflowRunApi* | [**scheduled_workflow_run_create**](docs/WorkflowRunApi.md#scheduled_workflow_run_create) | **POST** /api/v1/tenants/{tenant}/workflows/{workflow}/scheduled | Trigger workflow run
|
|
206
|
+
*HatchetSdkRest::WorkflowRunApi* | [**workflow_run_cancel**](docs/WorkflowRunApi.md#workflow_run_cancel) | **POST** /api/v1/tenants/{tenant}/workflows/cancel | Cancel workflow runs
|
|
207
|
+
*HatchetSdkRest::WorkflowRunApi* | [**workflow_run_create**](docs/WorkflowRunApi.md#workflow_run_create) | **POST** /api/v1/workflows/{workflow}/trigger | Trigger workflow run
|
|
208
|
+
*HatchetSdkRest::WorkflowRunApi* | [**workflow_run_get_input**](docs/WorkflowRunApi.md#workflow_run_get_input) | **GET** /api/v1/tenants/{tenant}/workflow-runs/{workflow-run}/input | Get workflow run input
|
|
209
|
+
*HatchetSdkRest::WorkflowRunApi* | [**workflow_run_update_replay**](docs/WorkflowRunApi.md#workflow_run_update_replay) | **POST** /api/v1/tenants/{tenant}/workflow-runs/replay | Replay workflow runs
|
|
210
|
+
*HatchetSdkRest::WorkflowRunsApi* | [**v1_workflow_run_create**](docs/WorkflowRunsApi.md#v1_workflow_run_create) | **POST** /api/v1/stable/tenants/{tenant}/workflow-runs/trigger | Create workflow run
|
|
211
|
+
*HatchetSdkRest::WorkflowRunsApi* | [**v1_workflow_run_display_names_list**](docs/WorkflowRunsApi.md#v1_workflow_run_display_names_list) | **GET** /api/v1/stable/tenants/{tenant}/workflow-runs/display-names | List workflow runs
|
|
212
|
+
*HatchetSdkRest::WorkflowRunsApi* | [**v1_workflow_run_get**](docs/WorkflowRunsApi.md#v1_workflow_run_get) | **GET** /api/v1/stable/workflow-runs/{v1-workflow-run} | List tasks
|
|
213
|
+
*HatchetSdkRest::WorkflowRunsApi* | [**v1_workflow_run_get_status**](docs/WorkflowRunsApi.md#v1_workflow_run_get_status) | **GET** /api/v1/stable/workflow-runs/{v1-workflow-run}/status | Get workflow run status
|
|
214
|
+
*HatchetSdkRest::WorkflowRunsApi* | [**v1_workflow_run_get_timings**](docs/WorkflowRunsApi.md#v1_workflow_run_get_timings) | **GET** /api/v1/stable/workflow-runs/{v1-workflow-run}/task-timings | List timings for a workflow run
|
|
215
|
+
*HatchetSdkRest::WorkflowRunsApi* | [**v1_workflow_run_list**](docs/WorkflowRunsApi.md#v1_workflow_run_list) | **GET** /api/v1/stable/tenants/{tenant}/workflow-runs | List workflow runs
|
|
216
|
+
*HatchetSdkRest::WorkflowRunsApi* | [**v1_workflow_run_task_events_list**](docs/WorkflowRunsApi.md#v1_workflow_run_task_events_list) | **GET** /api/v1/stable/workflow-runs/{v1-workflow-run}/task-events | List tasks
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
## Documentation for Models
|
|
220
|
+
|
|
221
|
+
- [HatchetSdkRest::APIError](docs/APIError.md)
|
|
222
|
+
- [HatchetSdkRest::APIErrors](docs/APIErrors.md)
|
|
223
|
+
- [HatchetSdkRest::APIMeta](docs/APIMeta.md)
|
|
224
|
+
- [HatchetSdkRest::APIMetaAuth](docs/APIMetaAuth.md)
|
|
225
|
+
- [HatchetSdkRest::APIMetaIntegration](docs/APIMetaIntegration.md)
|
|
226
|
+
- [HatchetSdkRest::APIMetaPosthog](docs/APIMetaPosthog.md)
|
|
227
|
+
- [HatchetSdkRest::APIResourceMeta](docs/APIResourceMeta.md)
|
|
228
|
+
- [HatchetSdkRest::APIToken](docs/APIToken.md)
|
|
229
|
+
- [HatchetSdkRest::AcceptInviteRequest](docs/AcceptInviteRequest.md)
|
|
230
|
+
- [HatchetSdkRest::BulkCreateEventRequest](docs/BulkCreateEventRequest.md)
|
|
231
|
+
- [HatchetSdkRest::CancelEventRequest](docs/CancelEventRequest.md)
|
|
232
|
+
- [HatchetSdkRest::ConcurrencyLimitStrategy](docs/ConcurrencyLimitStrategy.md)
|
|
233
|
+
- [HatchetSdkRest::CreateAPITokenRequest](docs/CreateAPITokenRequest.md)
|
|
234
|
+
- [HatchetSdkRest::CreateAPITokenResponse](docs/CreateAPITokenResponse.md)
|
|
235
|
+
- [HatchetSdkRest::CreateCronWorkflowTriggerRequest](docs/CreateCronWorkflowTriggerRequest.md)
|
|
236
|
+
- [HatchetSdkRest::CreateEventRequest](docs/CreateEventRequest.md)
|
|
237
|
+
- [HatchetSdkRest::CreatePullRequestFromStepRun](docs/CreatePullRequestFromStepRun.md)
|
|
238
|
+
- [HatchetSdkRest::CreateSNSIntegrationRequest](docs/CreateSNSIntegrationRequest.md)
|
|
239
|
+
- [HatchetSdkRest::CreateTenantAlertEmailGroupRequest](docs/CreateTenantAlertEmailGroupRequest.md)
|
|
240
|
+
- [HatchetSdkRest::CreateTenantInviteRequest](docs/CreateTenantInviteRequest.md)
|
|
241
|
+
- [HatchetSdkRest::CreateTenantRequest](docs/CreateTenantRequest.md)
|
|
242
|
+
- [HatchetSdkRest::CronWorkflows](docs/CronWorkflows.md)
|
|
243
|
+
- [HatchetSdkRest::CronWorkflowsList](docs/CronWorkflowsList.md)
|
|
244
|
+
- [HatchetSdkRest::CronWorkflowsMethod](docs/CronWorkflowsMethod.md)
|
|
245
|
+
- [HatchetSdkRest::CronWorkflowsOrderByField](docs/CronWorkflowsOrderByField.md)
|
|
246
|
+
- [HatchetSdkRest::Event](docs/Event.md)
|
|
247
|
+
- [HatchetSdkRest::EventData](docs/EventData.md)
|
|
248
|
+
- [HatchetSdkRest::EventKeyList](docs/EventKeyList.md)
|
|
249
|
+
- [HatchetSdkRest::EventList](docs/EventList.md)
|
|
250
|
+
- [HatchetSdkRest::EventOrderByDirection](docs/EventOrderByDirection.md)
|
|
251
|
+
- [HatchetSdkRest::EventOrderByField](docs/EventOrderByField.md)
|
|
252
|
+
- [HatchetSdkRest::EventUpdateCancel200Response](docs/EventUpdateCancel200Response.md)
|
|
253
|
+
- [HatchetSdkRest::EventWorkflowRunSummary](docs/EventWorkflowRunSummary.md)
|
|
254
|
+
- [HatchetSdkRest::Events](docs/Events.md)
|
|
255
|
+
- [HatchetSdkRest::GetStepRunDiffResponse](docs/GetStepRunDiffResponse.md)
|
|
256
|
+
- [HatchetSdkRest::InfoGetVersion200Response](docs/InfoGetVersion200Response.md)
|
|
257
|
+
- [HatchetSdkRest::Job](docs/Job.md)
|
|
258
|
+
- [HatchetSdkRest::JobRun](docs/JobRun.md)
|
|
259
|
+
- [HatchetSdkRest::JobRunStatus](docs/JobRunStatus.md)
|
|
260
|
+
- [HatchetSdkRest::ListAPITokensResponse](docs/ListAPITokensResponse.md)
|
|
261
|
+
- [HatchetSdkRest::ListPullRequestsResponse](docs/ListPullRequestsResponse.md)
|
|
262
|
+
- [HatchetSdkRest::ListSNSIntegrations](docs/ListSNSIntegrations.md)
|
|
263
|
+
- [HatchetSdkRest::ListSlackWebhooks](docs/ListSlackWebhooks.md)
|
|
264
|
+
- [HatchetSdkRest::LogLine](docs/LogLine.md)
|
|
265
|
+
- [HatchetSdkRest::LogLineLevel](docs/LogLineLevel.md)
|
|
266
|
+
- [HatchetSdkRest::LogLineList](docs/LogLineList.md)
|
|
267
|
+
- [HatchetSdkRest::LogLineOrderByDirection](docs/LogLineOrderByDirection.md)
|
|
268
|
+
- [HatchetSdkRest::LogLineOrderByField](docs/LogLineOrderByField.md)
|
|
269
|
+
- [HatchetSdkRest::PaginationResponse](docs/PaginationResponse.md)
|
|
270
|
+
- [HatchetSdkRest::PullRequest](docs/PullRequest.md)
|
|
271
|
+
- [HatchetSdkRest::PullRequestState](docs/PullRequestState.md)
|
|
272
|
+
- [HatchetSdkRest::QueueMetrics](docs/QueueMetrics.md)
|
|
273
|
+
- [HatchetSdkRest::RateLimit](docs/RateLimit.md)
|
|
274
|
+
- [HatchetSdkRest::RateLimitList](docs/RateLimitList.md)
|
|
275
|
+
- [HatchetSdkRest::RateLimitOrderByDirection](docs/RateLimitOrderByDirection.md)
|
|
276
|
+
- [HatchetSdkRest::RateLimitOrderByField](docs/RateLimitOrderByField.md)
|
|
277
|
+
- [HatchetSdkRest::RecentStepRuns](docs/RecentStepRuns.md)
|
|
278
|
+
- [HatchetSdkRest::RejectInviteRequest](docs/RejectInviteRequest.md)
|
|
279
|
+
- [HatchetSdkRest::ReplayEventRequest](docs/ReplayEventRequest.md)
|
|
280
|
+
- [HatchetSdkRest::ReplayWorkflowRunsRequest](docs/ReplayWorkflowRunsRequest.md)
|
|
281
|
+
- [HatchetSdkRest::ReplayWorkflowRunsResponse](docs/ReplayWorkflowRunsResponse.md)
|
|
282
|
+
- [HatchetSdkRest::RerunStepRunRequest](docs/RerunStepRunRequest.md)
|
|
283
|
+
- [HatchetSdkRest::SNSIntegration](docs/SNSIntegration.md)
|
|
284
|
+
- [HatchetSdkRest::ScheduleWorkflowRunRequest](docs/ScheduleWorkflowRunRequest.md)
|
|
285
|
+
- [HatchetSdkRest::ScheduledRunStatus](docs/ScheduledRunStatus.md)
|
|
286
|
+
- [HatchetSdkRest::ScheduledWorkflows](docs/ScheduledWorkflows.md)
|
|
287
|
+
- [HatchetSdkRest::ScheduledWorkflowsList](docs/ScheduledWorkflowsList.md)
|
|
288
|
+
- [HatchetSdkRest::ScheduledWorkflowsMethod](docs/ScheduledWorkflowsMethod.md)
|
|
289
|
+
- [HatchetSdkRest::ScheduledWorkflowsOrderByField](docs/ScheduledWorkflowsOrderByField.md)
|
|
290
|
+
- [HatchetSdkRest::SemaphoreSlots](docs/SemaphoreSlots.md)
|
|
291
|
+
- [HatchetSdkRest::SlackWebhook](docs/SlackWebhook.md)
|
|
292
|
+
- [HatchetSdkRest::Step](docs/Step.md)
|
|
293
|
+
- [HatchetSdkRest::StepRun](docs/StepRun.md)
|
|
294
|
+
- [HatchetSdkRest::StepRunArchive](docs/StepRunArchive.md)
|
|
295
|
+
- [HatchetSdkRest::StepRunArchiveList](docs/StepRunArchiveList.md)
|
|
296
|
+
- [HatchetSdkRest::StepRunDiff](docs/StepRunDiff.md)
|
|
297
|
+
- [HatchetSdkRest::StepRunEvent](docs/StepRunEvent.md)
|
|
298
|
+
- [HatchetSdkRest::StepRunEventList](docs/StepRunEventList.md)
|
|
299
|
+
- [HatchetSdkRest::StepRunEventReason](docs/StepRunEventReason.md)
|
|
300
|
+
- [HatchetSdkRest::StepRunEventSeverity](docs/StepRunEventSeverity.md)
|
|
301
|
+
- [HatchetSdkRest::StepRunStatus](docs/StepRunStatus.md)
|
|
302
|
+
- [HatchetSdkRest::Tenant](docs/Tenant.md)
|
|
303
|
+
- [HatchetSdkRest::TenantAlertEmailGroup](docs/TenantAlertEmailGroup.md)
|
|
304
|
+
- [HatchetSdkRest::TenantAlertEmailGroupList](docs/TenantAlertEmailGroupList.md)
|
|
305
|
+
- [HatchetSdkRest::TenantAlertingSettings](docs/TenantAlertingSettings.md)
|
|
306
|
+
- [HatchetSdkRest::TenantInvite](docs/TenantInvite.md)
|
|
307
|
+
- [HatchetSdkRest::TenantInviteList](docs/TenantInviteList.md)
|
|
308
|
+
- [HatchetSdkRest::TenantList](docs/TenantList.md)
|
|
309
|
+
- [HatchetSdkRest::TenantMember](docs/TenantMember.md)
|
|
310
|
+
- [HatchetSdkRest::TenantMemberList](docs/TenantMemberList.md)
|
|
311
|
+
- [HatchetSdkRest::TenantMemberRole](docs/TenantMemberRole.md)
|
|
312
|
+
- [HatchetSdkRest::TenantQueueMetrics](docs/TenantQueueMetrics.md)
|
|
313
|
+
- [HatchetSdkRest::TenantResource](docs/TenantResource.md)
|
|
314
|
+
- [HatchetSdkRest::TenantResourceLimit](docs/TenantResourceLimit.md)
|
|
315
|
+
- [HatchetSdkRest::TenantResourcePolicy](docs/TenantResourcePolicy.md)
|
|
316
|
+
- [HatchetSdkRest::TenantStepRunQueueMetrics](docs/TenantStepRunQueueMetrics.md)
|
|
317
|
+
- [HatchetSdkRest::TenantUIVersion](docs/TenantUIVersion.md)
|
|
318
|
+
- [HatchetSdkRest::TenantVersion](docs/TenantVersion.md)
|
|
319
|
+
- [HatchetSdkRest::TriggerWorkflowRunRequest](docs/TriggerWorkflowRunRequest.md)
|
|
320
|
+
- [HatchetSdkRest::UpdateTenantAlertEmailGroupRequest](docs/UpdateTenantAlertEmailGroupRequest.md)
|
|
321
|
+
- [HatchetSdkRest::UpdateTenantInviteRequest](docs/UpdateTenantInviteRequest.md)
|
|
322
|
+
- [HatchetSdkRest::UpdateTenantRequest](docs/UpdateTenantRequest.md)
|
|
323
|
+
- [HatchetSdkRest::UpdateWorkerRequest](docs/UpdateWorkerRequest.md)
|
|
324
|
+
- [HatchetSdkRest::User](docs/User.md)
|
|
325
|
+
- [HatchetSdkRest::UserChangePasswordRequest](docs/UserChangePasswordRequest.md)
|
|
326
|
+
- [HatchetSdkRest::UserLoginRequest](docs/UserLoginRequest.md)
|
|
327
|
+
- [HatchetSdkRest::UserRegisterRequest](docs/UserRegisterRequest.md)
|
|
328
|
+
- [HatchetSdkRest::UserTenantMembershipsList](docs/UserTenantMembershipsList.md)
|
|
329
|
+
- [HatchetSdkRest::UserTenantPublic](docs/UserTenantPublic.md)
|
|
330
|
+
- [HatchetSdkRest::V1CancelTaskRequest](docs/V1CancelTaskRequest.md)
|
|
331
|
+
- [HatchetSdkRest::V1CancelledTasks](docs/V1CancelledTasks.md)
|
|
332
|
+
- [HatchetSdkRest::V1CreateFilterRequest](docs/V1CreateFilterRequest.md)
|
|
333
|
+
- [HatchetSdkRest::V1DagChildren](docs/V1DagChildren.md)
|
|
334
|
+
- [HatchetSdkRest::V1Event](docs/V1Event.md)
|
|
335
|
+
- [HatchetSdkRest::V1EventList](docs/V1EventList.md)
|
|
336
|
+
- [HatchetSdkRest::V1EventTriggeredRun](docs/V1EventTriggeredRun.md)
|
|
337
|
+
- [HatchetSdkRest::V1EventWorkflowRunSummary](docs/V1EventWorkflowRunSummary.md)
|
|
338
|
+
- [HatchetSdkRest::V1Filter](docs/V1Filter.md)
|
|
339
|
+
- [HatchetSdkRest::V1FilterList](docs/V1FilterList.md)
|
|
340
|
+
- [HatchetSdkRest::V1LogLine](docs/V1LogLine.md)
|
|
341
|
+
- [HatchetSdkRest::V1LogLineLevel](docs/V1LogLineLevel.md)
|
|
342
|
+
- [HatchetSdkRest::V1LogLineList](docs/V1LogLineList.md)
|
|
343
|
+
- [HatchetSdkRest::V1ReplayTaskRequest](docs/V1ReplayTaskRequest.md)
|
|
344
|
+
- [HatchetSdkRest::V1ReplayedTasks](docs/V1ReplayedTasks.md)
|
|
345
|
+
- [HatchetSdkRest::V1TaskEvent](docs/V1TaskEvent.md)
|
|
346
|
+
- [HatchetSdkRest::V1TaskEventList](docs/V1TaskEventList.md)
|
|
347
|
+
- [HatchetSdkRest::V1TaskEventType](docs/V1TaskEventType.md)
|
|
348
|
+
- [HatchetSdkRest::V1TaskFilter](docs/V1TaskFilter.md)
|
|
349
|
+
- [HatchetSdkRest::V1TaskPointMetric](docs/V1TaskPointMetric.md)
|
|
350
|
+
- [HatchetSdkRest::V1TaskPointMetrics](docs/V1TaskPointMetrics.md)
|
|
351
|
+
- [HatchetSdkRest::V1TaskRunMetric](docs/V1TaskRunMetric.md)
|
|
352
|
+
- [HatchetSdkRest::V1TaskRunStatus](docs/V1TaskRunStatus.md)
|
|
353
|
+
- [HatchetSdkRest::V1TaskStatus](docs/V1TaskStatus.md)
|
|
354
|
+
- [HatchetSdkRest::V1TaskSummary](docs/V1TaskSummary.md)
|
|
355
|
+
- [HatchetSdkRest::V1TaskSummaryList](docs/V1TaskSummaryList.md)
|
|
356
|
+
- [HatchetSdkRest::V1TaskTiming](docs/V1TaskTiming.md)
|
|
357
|
+
- [HatchetSdkRest::V1TaskTimingList](docs/V1TaskTimingList.md)
|
|
358
|
+
- [HatchetSdkRest::V1TriggerWorkflowRunRequest](docs/V1TriggerWorkflowRunRequest.md)
|
|
359
|
+
- [HatchetSdkRest::V1UpdateFilterRequest](docs/V1UpdateFilterRequest.md)
|
|
360
|
+
- [HatchetSdkRest::V1WorkflowRun](docs/V1WorkflowRun.md)
|
|
361
|
+
- [HatchetSdkRest::V1WorkflowRunDetails](docs/V1WorkflowRunDetails.md)
|
|
362
|
+
- [HatchetSdkRest::V1WorkflowRunDisplayName](docs/V1WorkflowRunDisplayName.md)
|
|
363
|
+
- [HatchetSdkRest::V1WorkflowRunDisplayNameList](docs/V1WorkflowRunDisplayNameList.md)
|
|
364
|
+
- [HatchetSdkRest::V1WorkflowType](docs/V1WorkflowType.md)
|
|
365
|
+
- [HatchetSdkRest::WebhookWorker](docs/WebhookWorker.md)
|
|
366
|
+
- [HatchetSdkRest::WebhookWorkerCreateRequest](docs/WebhookWorkerCreateRequest.md)
|
|
367
|
+
- [HatchetSdkRest::WebhookWorkerCreateResponse](docs/WebhookWorkerCreateResponse.md)
|
|
368
|
+
- [HatchetSdkRest::WebhookWorkerCreated](docs/WebhookWorkerCreated.md)
|
|
369
|
+
- [HatchetSdkRest::WebhookWorkerListResponse](docs/WebhookWorkerListResponse.md)
|
|
370
|
+
- [HatchetSdkRest::WebhookWorkerRequest](docs/WebhookWorkerRequest.md)
|
|
371
|
+
- [HatchetSdkRest::WebhookWorkerRequestListResponse](docs/WebhookWorkerRequestListResponse.md)
|
|
372
|
+
- [HatchetSdkRest::WebhookWorkerRequestMethod](docs/WebhookWorkerRequestMethod.md)
|
|
373
|
+
- [HatchetSdkRest::Worker](docs/Worker.md)
|
|
374
|
+
- [HatchetSdkRest::WorkerLabel](docs/WorkerLabel.md)
|
|
375
|
+
- [HatchetSdkRest::WorkerList](docs/WorkerList.md)
|
|
376
|
+
- [HatchetSdkRest::WorkerRuntimeInfo](docs/WorkerRuntimeInfo.md)
|
|
377
|
+
- [HatchetSdkRest::WorkerRuntimeSDKs](docs/WorkerRuntimeSDKs.md)
|
|
378
|
+
- [HatchetSdkRest::WorkerType](docs/WorkerType.md)
|
|
379
|
+
- [HatchetSdkRest::Workflow](docs/Workflow.md)
|
|
380
|
+
- [HatchetSdkRest::WorkflowConcurrency](docs/WorkflowConcurrency.md)
|
|
381
|
+
- [HatchetSdkRest::WorkflowKind](docs/WorkflowKind.md)
|
|
382
|
+
- [HatchetSdkRest::WorkflowList](docs/WorkflowList.md)
|
|
383
|
+
- [HatchetSdkRest::WorkflowMetrics](docs/WorkflowMetrics.md)
|
|
384
|
+
- [HatchetSdkRest::WorkflowRun](docs/WorkflowRun.md)
|
|
385
|
+
- [HatchetSdkRest::WorkflowRunList](docs/WorkflowRunList.md)
|
|
386
|
+
- [HatchetSdkRest::WorkflowRunOrderByDirection](docs/WorkflowRunOrderByDirection.md)
|
|
387
|
+
- [HatchetSdkRest::WorkflowRunOrderByField](docs/WorkflowRunOrderByField.md)
|
|
388
|
+
- [HatchetSdkRest::WorkflowRunShape](docs/WorkflowRunShape.md)
|
|
389
|
+
- [HatchetSdkRest::WorkflowRunShapeItemForWorkflowRunDetails](docs/WorkflowRunShapeItemForWorkflowRunDetails.md)
|
|
390
|
+
- [HatchetSdkRest::WorkflowRunStatus](docs/WorkflowRunStatus.md)
|
|
391
|
+
- [HatchetSdkRest::WorkflowRunTriggeredBy](docs/WorkflowRunTriggeredBy.md)
|
|
392
|
+
- [HatchetSdkRest::WorkflowRunsCancelRequest](docs/WorkflowRunsCancelRequest.md)
|
|
393
|
+
- [HatchetSdkRest::WorkflowRunsMetrics](docs/WorkflowRunsMetrics.md)
|
|
394
|
+
- [HatchetSdkRest::WorkflowRunsMetricsCounts](docs/WorkflowRunsMetricsCounts.md)
|
|
395
|
+
- [HatchetSdkRest::WorkflowTag](docs/WorkflowTag.md)
|
|
396
|
+
- [HatchetSdkRest::WorkflowTriggerCronRef](docs/WorkflowTriggerCronRef.md)
|
|
397
|
+
- [HatchetSdkRest::WorkflowTriggerEventRef](docs/WorkflowTriggerEventRef.md)
|
|
398
|
+
- [HatchetSdkRest::WorkflowTriggers](docs/WorkflowTriggers.md)
|
|
399
|
+
- [HatchetSdkRest::WorkflowUpdateRequest](docs/WorkflowUpdateRequest.md)
|
|
400
|
+
- [HatchetSdkRest::WorkflowVersion](docs/WorkflowVersion.md)
|
|
401
|
+
- [HatchetSdkRest::WorkflowVersionDefinition](docs/WorkflowVersionDefinition.md)
|
|
402
|
+
- [HatchetSdkRest::WorkflowVersionMeta](docs/WorkflowVersionMeta.md)
|
|
403
|
+
- [HatchetSdkRest::WorkflowWorkersCount](docs/WorkflowWorkersCount.md)
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
## Documentation for Authorization
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
Authentication schemes defined for the API:
|
|
410
|
+
### bearerAuth
|
|
411
|
+
|
|
412
|
+
- **Type**: Bearer authentication
|
|
413
|
+
|
|
414
|
+
### cookieAuth
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
- **Type**: API key
|
|
418
|
+
- **API key parameter name**: hatchet
|
|
419
|
+
- **Location**:
|
|
420
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# HatchetSdkRest::APIError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **description** | **String** | a description for this error | |
|
|
8
|
+
| **code** | **Integer** | a custom Hatchet error code | [optional] |
|
|
9
|
+
| **field** | **String** | the field that this error is associated with, if applicable | [optional] |
|
|
10
|
+
| **docs_link** | **String** | a link to the documentation for this error, if it exists | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'hatchet-sdk-rest'
|
|
16
|
+
|
|
17
|
+
instance = HatchetSdkRest::APIError.new(
|
|
18
|
+
description: A descriptive error message,
|
|
19
|
+
code: 1400,
|
|
20
|
+
field: name,
|
|
21
|
+
docs_link: github.com/hatchet-dev/hatchet
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# HatchetSdkRest::APIErrors
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **errors** | [**Array<APIError>**](APIError.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'hatchet-sdk-rest'
|
|
13
|
+
|
|
14
|
+
instance = HatchetSdkRest::APIErrors.new(
|
|
15
|
+
errors: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# HatchetSdkRest::APIMeta
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **auth** | [**APIMetaAuth**](APIMetaAuth.md) | | [optional] |
|
|
8
|
+
| **pylon_app_id** | **String** | the Pylon app ID for usepylon.com chat support | [optional] |
|
|
9
|
+
| **posthog** | [**APIMetaPosthog**](APIMetaPosthog.md) | | [optional] |
|
|
10
|
+
| **allow_signup** | **Boolean** | whether or not users can sign up for this instance | [optional] |
|
|
11
|
+
| **allow_invites** | **Boolean** | whether or not users can invite other users to this instance | [optional] |
|
|
12
|
+
| **allow_create_tenant** | **Boolean** | whether or not users can create new tenants | [optional] |
|
|
13
|
+
| **allow_change_password** | **Boolean** | whether or not users can change their password | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'hatchet-sdk-rest'
|
|
19
|
+
|
|
20
|
+
instance = HatchetSdkRest::APIMeta.new(
|
|
21
|
+
auth: null,
|
|
22
|
+
pylon_app_id: 12345678-1234-1234-1234-123456789012,
|
|
23
|
+
posthog: null,
|
|
24
|
+
allow_signup: true,
|
|
25
|
+
allow_invites: true,
|
|
26
|
+
allow_create_tenant: true,
|
|
27
|
+
allow_change_password: true
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# HatchetSdkRest::APIMetaAuth
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **schemes** | **Array<String>** | the supported types of authentication | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'hatchet-sdk-rest'
|
|
13
|
+
|
|
14
|
+
instance = HatchetSdkRest::APIMetaAuth.new(
|
|
15
|
+
schemes: [basic, google]
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# HatchetSdkRest::APIMetaIntegration
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | the name of the integration | |
|
|
8
|
+
| **enabled** | **Boolean** | whether this integration is enabled on the instance | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'hatchet-sdk-rest'
|
|
14
|
+
|
|
15
|
+
instance = HatchetSdkRest::APIMetaIntegration.new(
|
|
16
|
+
name: github,
|
|
17
|
+
enabled: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# HatchetSdkRest::APIMetaPosthog
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **api_key** | **String** | the PostHog API key | [optional] |
|
|
8
|
+
| **api_host** | **String** | the PostHog API host | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'hatchet-sdk-rest'
|
|
14
|
+
|
|
15
|
+
instance = HatchetSdkRest::APIMetaPosthog.new(
|
|
16
|
+
api_key: phk_1234567890abcdef,
|
|
17
|
+
api_host: https://posthog.example.com
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# HatchetSdkRest::APIResourceMeta
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | the id of this resource, in UUID format | |
|
|
8
|
+
| **created_at** | **Time** | the time that this resource was created | |
|
|
9
|
+
| **updated_at** | **Time** | the time that this resource was last updated | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'hatchet-sdk-rest'
|
|
15
|
+
|
|
16
|
+
instance = HatchetSdkRest::APIResourceMeta.new(
|
|
17
|
+
id: bb214807-246e-43a5-a25d-41761d1cff9e,
|
|
18
|
+
created_at: 2022-12-13T15:06:48.888358-05:00,
|
|
19
|
+
updated_at: 2022-12-13T15:06:48.888358-05:00
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# HatchetSdkRest::APIToken
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) | | |
|
|
8
|
+
| **name** | **String** | The name of the API token. | |
|
|
9
|
+
| **expires_at** | **Time** | When the API token expires. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'hatchet-sdk-rest'
|
|
15
|
+
|
|
16
|
+
instance = HatchetSdkRest::APIToken.new(
|
|
17
|
+
metadata: null,
|
|
18
|
+
name: null,
|
|
19
|
+
expires_at: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|