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,1362 @@
|
|
|
1
|
+
# HatchetSdkRest::TenantApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**alert_email_group_create**](TenantApi.md#alert_email_group_create) | **POST** /api/v1/tenants/{tenant}/alerting-email-groups | Create tenant alert email group |
|
|
8
|
+
| [**alert_email_group_delete**](TenantApi.md#alert_email_group_delete) | **DELETE** /api/v1/alerting-email-groups/{alert-email-group} | Delete tenant alert email group |
|
|
9
|
+
| [**alert_email_group_list**](TenantApi.md#alert_email_group_list) | **GET** /api/v1/tenants/{tenant}/alerting-email-groups | List tenant alert email groups |
|
|
10
|
+
| [**alert_email_group_update**](TenantApi.md#alert_email_group_update) | **PATCH** /api/v1/alerting-email-groups/{alert-email-group} | Update tenant alert email group |
|
|
11
|
+
| [**tenant_alerting_settings_get**](TenantApi.md#tenant_alerting_settings_get) | **GET** /api/v1/tenants/{tenant}/alerting/settings | Get tenant alerting settings |
|
|
12
|
+
| [**tenant_create**](TenantApi.md#tenant_create) | **POST** /api/v1/tenants | Create tenant |
|
|
13
|
+
| [**tenant_get**](TenantApi.md#tenant_get) | **GET** /api/v1/tenants/{tenant} | Get tenant |
|
|
14
|
+
| [**tenant_get_prometheus_metrics**](TenantApi.md#tenant_get_prometheus_metrics) | **GET** /api/v1/tenants/{tenant}/prometheus-metrics | Get prometheus metrics |
|
|
15
|
+
| [**tenant_get_step_run_queue_metrics**](TenantApi.md#tenant_get_step_run_queue_metrics) | **GET** /api/v1/tenants/{tenant}/step-run-queue-metrics | Get step run metrics |
|
|
16
|
+
| [**tenant_invite_accept**](TenantApi.md#tenant_invite_accept) | **POST** /api/v1/users/invites/accept | Accept tenant invite |
|
|
17
|
+
| [**tenant_invite_create**](TenantApi.md#tenant_invite_create) | **POST** /api/v1/tenants/{tenant}/invites | Create tenant invite |
|
|
18
|
+
| [**tenant_invite_list**](TenantApi.md#tenant_invite_list) | **GET** /api/v1/tenants/{tenant}/invites | List tenant invites |
|
|
19
|
+
| [**tenant_invite_reject**](TenantApi.md#tenant_invite_reject) | **POST** /api/v1/users/invites/reject | Reject tenant invite |
|
|
20
|
+
| [**tenant_member_delete**](TenantApi.md#tenant_member_delete) | **DELETE** /api/v1/tenants/{tenant}/members/{member} | Delete a tenant member |
|
|
21
|
+
| [**tenant_member_list**](TenantApi.md#tenant_member_list) | **GET** /api/v1/tenants/{tenant}/members | List tenant members |
|
|
22
|
+
| [**tenant_resource_policy_get**](TenantApi.md#tenant_resource_policy_get) | **GET** /api/v1/tenants/{tenant}/resource-policy | Create tenant alert email group |
|
|
23
|
+
| [**tenant_update**](TenantApi.md#tenant_update) | **PATCH** /api/v1/tenants/{tenant} | Update tenant |
|
|
24
|
+
| [**user_list_tenant_invites**](TenantApi.md#user_list_tenant_invites) | **GET** /api/v1/users/invites | List tenant invites |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## alert_email_group_create
|
|
28
|
+
|
|
29
|
+
> <TenantAlertEmailGroup> alert_email_group_create(tenant, create_tenant_alert_email_group_request)
|
|
30
|
+
|
|
31
|
+
Create tenant alert email group
|
|
32
|
+
|
|
33
|
+
Creates a new tenant alert email group
|
|
34
|
+
|
|
35
|
+
### Examples
|
|
36
|
+
|
|
37
|
+
```ruby
|
|
38
|
+
require 'time'
|
|
39
|
+
require 'hatchet-sdk-rest'
|
|
40
|
+
# setup authorization
|
|
41
|
+
HatchetSdkRest.configure do |config|
|
|
42
|
+
# Configure API key authorization: cookieAuth
|
|
43
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
44
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
45
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
46
|
+
|
|
47
|
+
# Configure Bearer authorization: bearerAuth
|
|
48
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
52
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
53
|
+
create_tenant_alert_email_group_request = HatchetSdkRest::CreateTenantAlertEmailGroupRequest.new({emails: ['emails_example']}) # CreateTenantAlertEmailGroupRequest | The tenant alert email group to create
|
|
54
|
+
|
|
55
|
+
begin
|
|
56
|
+
# Create tenant alert email group
|
|
57
|
+
result = api_instance.alert_email_group_create(tenant, create_tenant_alert_email_group_request)
|
|
58
|
+
p result
|
|
59
|
+
rescue HatchetSdkRest::ApiError => e
|
|
60
|
+
puts "Error when calling TenantApi->alert_email_group_create: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
#### Using the alert_email_group_create_with_http_info variant
|
|
65
|
+
|
|
66
|
+
This returns an Array which contains the response data, status code and headers.
|
|
67
|
+
|
|
68
|
+
> <Array(<TenantAlertEmailGroup>, Integer, Hash)> alert_email_group_create_with_http_info(tenant, create_tenant_alert_email_group_request)
|
|
69
|
+
|
|
70
|
+
```ruby
|
|
71
|
+
begin
|
|
72
|
+
# Create tenant alert email group
|
|
73
|
+
data, status_code, headers = api_instance.alert_email_group_create_with_http_info(tenant, create_tenant_alert_email_group_request)
|
|
74
|
+
p status_code # => 2xx
|
|
75
|
+
p headers # => { ... }
|
|
76
|
+
p data # => <TenantAlertEmailGroup>
|
|
77
|
+
rescue HatchetSdkRest::ApiError => e
|
|
78
|
+
puts "Error when calling TenantApi->alert_email_group_create_with_http_info: #{e}"
|
|
79
|
+
end
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Parameters
|
|
83
|
+
|
|
84
|
+
| Name | Type | Description | Notes |
|
|
85
|
+
| ---- | ---- | ----------- | ----- |
|
|
86
|
+
| **tenant** | **String** | The tenant id | |
|
|
87
|
+
| **create_tenant_alert_email_group_request** | [**CreateTenantAlertEmailGroupRequest**](CreateTenantAlertEmailGroupRequest.md) | The tenant alert email group to create | |
|
|
88
|
+
|
|
89
|
+
### Return type
|
|
90
|
+
|
|
91
|
+
[**TenantAlertEmailGroup**](TenantAlertEmailGroup.md)
|
|
92
|
+
|
|
93
|
+
### Authorization
|
|
94
|
+
|
|
95
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
96
|
+
|
|
97
|
+
### HTTP request headers
|
|
98
|
+
|
|
99
|
+
- **Content-Type**: application/json
|
|
100
|
+
- **Accept**: application/json
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
## alert_email_group_delete
|
|
104
|
+
|
|
105
|
+
> alert_email_group_delete(alert_email_group)
|
|
106
|
+
|
|
107
|
+
Delete tenant alert email group
|
|
108
|
+
|
|
109
|
+
Deletes a tenant alert email group
|
|
110
|
+
|
|
111
|
+
### Examples
|
|
112
|
+
|
|
113
|
+
```ruby
|
|
114
|
+
require 'time'
|
|
115
|
+
require 'hatchet-sdk-rest'
|
|
116
|
+
# setup authorization
|
|
117
|
+
HatchetSdkRest.configure do |config|
|
|
118
|
+
# Configure API key authorization: cookieAuth
|
|
119
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
120
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
121
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
122
|
+
|
|
123
|
+
# Configure Bearer authorization: bearerAuth
|
|
124
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
128
|
+
alert_email_group = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant alert email group id
|
|
129
|
+
|
|
130
|
+
begin
|
|
131
|
+
# Delete tenant alert email group
|
|
132
|
+
api_instance.alert_email_group_delete(alert_email_group)
|
|
133
|
+
rescue HatchetSdkRest::ApiError => e
|
|
134
|
+
puts "Error when calling TenantApi->alert_email_group_delete: #{e}"
|
|
135
|
+
end
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
#### Using the alert_email_group_delete_with_http_info variant
|
|
139
|
+
|
|
140
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
141
|
+
|
|
142
|
+
> <Array(nil, Integer, Hash)> alert_email_group_delete_with_http_info(alert_email_group)
|
|
143
|
+
|
|
144
|
+
```ruby
|
|
145
|
+
begin
|
|
146
|
+
# Delete tenant alert email group
|
|
147
|
+
data, status_code, headers = api_instance.alert_email_group_delete_with_http_info(alert_email_group)
|
|
148
|
+
p status_code # => 2xx
|
|
149
|
+
p headers # => { ... }
|
|
150
|
+
p data # => nil
|
|
151
|
+
rescue HatchetSdkRest::ApiError => e
|
|
152
|
+
puts "Error when calling TenantApi->alert_email_group_delete_with_http_info: #{e}"
|
|
153
|
+
end
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Parameters
|
|
157
|
+
|
|
158
|
+
| Name | Type | Description | Notes |
|
|
159
|
+
| ---- | ---- | ----------- | ----- |
|
|
160
|
+
| **alert_email_group** | **String** | The tenant alert email group id | |
|
|
161
|
+
|
|
162
|
+
### Return type
|
|
163
|
+
|
|
164
|
+
nil (empty response body)
|
|
165
|
+
|
|
166
|
+
### Authorization
|
|
167
|
+
|
|
168
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
169
|
+
|
|
170
|
+
### HTTP request headers
|
|
171
|
+
|
|
172
|
+
- **Content-Type**: Not defined
|
|
173
|
+
- **Accept**: application/json
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
## alert_email_group_list
|
|
177
|
+
|
|
178
|
+
> <TenantAlertEmailGroupList> alert_email_group_list(tenant)
|
|
179
|
+
|
|
180
|
+
List tenant alert email groups
|
|
181
|
+
|
|
182
|
+
Gets a list of tenant alert email groups
|
|
183
|
+
|
|
184
|
+
### Examples
|
|
185
|
+
|
|
186
|
+
```ruby
|
|
187
|
+
require 'time'
|
|
188
|
+
require 'hatchet-sdk-rest'
|
|
189
|
+
# setup authorization
|
|
190
|
+
HatchetSdkRest.configure do |config|
|
|
191
|
+
# Configure API key authorization: cookieAuth
|
|
192
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
193
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
194
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
195
|
+
|
|
196
|
+
# Configure Bearer authorization: bearerAuth
|
|
197
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
198
|
+
end
|
|
199
|
+
|
|
200
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
201
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
202
|
+
|
|
203
|
+
begin
|
|
204
|
+
# List tenant alert email groups
|
|
205
|
+
result = api_instance.alert_email_group_list(tenant)
|
|
206
|
+
p result
|
|
207
|
+
rescue HatchetSdkRest::ApiError => e
|
|
208
|
+
puts "Error when calling TenantApi->alert_email_group_list: #{e}"
|
|
209
|
+
end
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
#### Using the alert_email_group_list_with_http_info variant
|
|
213
|
+
|
|
214
|
+
This returns an Array which contains the response data, status code and headers.
|
|
215
|
+
|
|
216
|
+
> <Array(<TenantAlertEmailGroupList>, Integer, Hash)> alert_email_group_list_with_http_info(tenant)
|
|
217
|
+
|
|
218
|
+
```ruby
|
|
219
|
+
begin
|
|
220
|
+
# List tenant alert email groups
|
|
221
|
+
data, status_code, headers = api_instance.alert_email_group_list_with_http_info(tenant)
|
|
222
|
+
p status_code # => 2xx
|
|
223
|
+
p headers # => { ... }
|
|
224
|
+
p data # => <TenantAlertEmailGroupList>
|
|
225
|
+
rescue HatchetSdkRest::ApiError => e
|
|
226
|
+
puts "Error when calling TenantApi->alert_email_group_list_with_http_info: #{e}"
|
|
227
|
+
end
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### Parameters
|
|
231
|
+
|
|
232
|
+
| Name | Type | Description | Notes |
|
|
233
|
+
| ---- | ---- | ----------- | ----- |
|
|
234
|
+
| **tenant** | **String** | The tenant id | |
|
|
235
|
+
|
|
236
|
+
### Return type
|
|
237
|
+
|
|
238
|
+
[**TenantAlertEmailGroupList**](TenantAlertEmailGroupList.md)
|
|
239
|
+
|
|
240
|
+
### Authorization
|
|
241
|
+
|
|
242
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
243
|
+
|
|
244
|
+
### HTTP request headers
|
|
245
|
+
|
|
246
|
+
- **Content-Type**: Not defined
|
|
247
|
+
- **Accept**: application/json
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
## alert_email_group_update
|
|
251
|
+
|
|
252
|
+
> <TenantAlertEmailGroup> alert_email_group_update(alert_email_group, update_tenant_alert_email_group_request)
|
|
253
|
+
|
|
254
|
+
Update tenant alert email group
|
|
255
|
+
|
|
256
|
+
Updates a tenant alert email group
|
|
257
|
+
|
|
258
|
+
### Examples
|
|
259
|
+
|
|
260
|
+
```ruby
|
|
261
|
+
require 'time'
|
|
262
|
+
require 'hatchet-sdk-rest'
|
|
263
|
+
# setup authorization
|
|
264
|
+
HatchetSdkRest.configure do |config|
|
|
265
|
+
# Configure API key authorization: cookieAuth
|
|
266
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
267
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
268
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
269
|
+
|
|
270
|
+
# Configure Bearer authorization: bearerAuth
|
|
271
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
272
|
+
end
|
|
273
|
+
|
|
274
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
275
|
+
alert_email_group = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant alert email group id
|
|
276
|
+
update_tenant_alert_email_group_request = HatchetSdkRest::UpdateTenantAlertEmailGroupRequest.new({emails: ['emails_example']}) # UpdateTenantAlertEmailGroupRequest | The tenant alert email group to update
|
|
277
|
+
|
|
278
|
+
begin
|
|
279
|
+
# Update tenant alert email group
|
|
280
|
+
result = api_instance.alert_email_group_update(alert_email_group, update_tenant_alert_email_group_request)
|
|
281
|
+
p result
|
|
282
|
+
rescue HatchetSdkRest::ApiError => e
|
|
283
|
+
puts "Error when calling TenantApi->alert_email_group_update: #{e}"
|
|
284
|
+
end
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
#### Using the alert_email_group_update_with_http_info variant
|
|
288
|
+
|
|
289
|
+
This returns an Array which contains the response data, status code and headers.
|
|
290
|
+
|
|
291
|
+
> <Array(<TenantAlertEmailGroup>, Integer, Hash)> alert_email_group_update_with_http_info(alert_email_group, update_tenant_alert_email_group_request)
|
|
292
|
+
|
|
293
|
+
```ruby
|
|
294
|
+
begin
|
|
295
|
+
# Update tenant alert email group
|
|
296
|
+
data, status_code, headers = api_instance.alert_email_group_update_with_http_info(alert_email_group, update_tenant_alert_email_group_request)
|
|
297
|
+
p status_code # => 2xx
|
|
298
|
+
p headers # => { ... }
|
|
299
|
+
p data # => <TenantAlertEmailGroup>
|
|
300
|
+
rescue HatchetSdkRest::ApiError => e
|
|
301
|
+
puts "Error when calling TenantApi->alert_email_group_update_with_http_info: #{e}"
|
|
302
|
+
end
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### Parameters
|
|
306
|
+
|
|
307
|
+
| Name | Type | Description | Notes |
|
|
308
|
+
| ---- | ---- | ----------- | ----- |
|
|
309
|
+
| **alert_email_group** | **String** | The tenant alert email group id | |
|
|
310
|
+
| **update_tenant_alert_email_group_request** | [**UpdateTenantAlertEmailGroupRequest**](UpdateTenantAlertEmailGroupRequest.md) | The tenant alert email group to update | |
|
|
311
|
+
|
|
312
|
+
### Return type
|
|
313
|
+
|
|
314
|
+
[**TenantAlertEmailGroup**](TenantAlertEmailGroup.md)
|
|
315
|
+
|
|
316
|
+
### Authorization
|
|
317
|
+
|
|
318
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
319
|
+
|
|
320
|
+
### HTTP request headers
|
|
321
|
+
|
|
322
|
+
- **Content-Type**: application/json
|
|
323
|
+
- **Accept**: application/json
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
## tenant_alerting_settings_get
|
|
327
|
+
|
|
328
|
+
> <TenantAlertingSettings> tenant_alerting_settings_get(tenant)
|
|
329
|
+
|
|
330
|
+
Get tenant alerting settings
|
|
331
|
+
|
|
332
|
+
Gets the alerting settings for a tenant
|
|
333
|
+
|
|
334
|
+
### Examples
|
|
335
|
+
|
|
336
|
+
```ruby
|
|
337
|
+
require 'time'
|
|
338
|
+
require 'hatchet-sdk-rest'
|
|
339
|
+
# setup authorization
|
|
340
|
+
HatchetSdkRest.configure do |config|
|
|
341
|
+
# Configure API key authorization: cookieAuth
|
|
342
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
343
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
344
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
345
|
+
|
|
346
|
+
# Configure Bearer authorization: bearerAuth
|
|
347
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
348
|
+
end
|
|
349
|
+
|
|
350
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
351
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
352
|
+
|
|
353
|
+
begin
|
|
354
|
+
# Get tenant alerting settings
|
|
355
|
+
result = api_instance.tenant_alerting_settings_get(tenant)
|
|
356
|
+
p result
|
|
357
|
+
rescue HatchetSdkRest::ApiError => e
|
|
358
|
+
puts "Error when calling TenantApi->tenant_alerting_settings_get: #{e}"
|
|
359
|
+
end
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
#### Using the tenant_alerting_settings_get_with_http_info variant
|
|
363
|
+
|
|
364
|
+
This returns an Array which contains the response data, status code and headers.
|
|
365
|
+
|
|
366
|
+
> <Array(<TenantAlertingSettings>, Integer, Hash)> tenant_alerting_settings_get_with_http_info(tenant)
|
|
367
|
+
|
|
368
|
+
```ruby
|
|
369
|
+
begin
|
|
370
|
+
# Get tenant alerting settings
|
|
371
|
+
data, status_code, headers = api_instance.tenant_alerting_settings_get_with_http_info(tenant)
|
|
372
|
+
p status_code # => 2xx
|
|
373
|
+
p headers # => { ... }
|
|
374
|
+
p data # => <TenantAlertingSettings>
|
|
375
|
+
rescue HatchetSdkRest::ApiError => e
|
|
376
|
+
puts "Error when calling TenantApi->tenant_alerting_settings_get_with_http_info: #{e}"
|
|
377
|
+
end
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
### Parameters
|
|
381
|
+
|
|
382
|
+
| Name | Type | Description | Notes |
|
|
383
|
+
| ---- | ---- | ----------- | ----- |
|
|
384
|
+
| **tenant** | **String** | The tenant id | |
|
|
385
|
+
|
|
386
|
+
### Return type
|
|
387
|
+
|
|
388
|
+
[**TenantAlertingSettings**](TenantAlertingSettings.md)
|
|
389
|
+
|
|
390
|
+
### Authorization
|
|
391
|
+
|
|
392
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
393
|
+
|
|
394
|
+
### HTTP request headers
|
|
395
|
+
|
|
396
|
+
- **Content-Type**: Not defined
|
|
397
|
+
- **Accept**: application/json
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
## tenant_create
|
|
401
|
+
|
|
402
|
+
> <Tenant> tenant_create(create_tenant_request)
|
|
403
|
+
|
|
404
|
+
Create tenant
|
|
405
|
+
|
|
406
|
+
Creates a new tenant
|
|
407
|
+
|
|
408
|
+
### Examples
|
|
409
|
+
|
|
410
|
+
```ruby
|
|
411
|
+
require 'time'
|
|
412
|
+
require 'hatchet-sdk-rest'
|
|
413
|
+
# setup authorization
|
|
414
|
+
HatchetSdkRest.configure do |config|
|
|
415
|
+
# Configure API key authorization: cookieAuth
|
|
416
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
417
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
418
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
419
|
+
|
|
420
|
+
# Configure Bearer authorization: bearerAuth
|
|
421
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
422
|
+
end
|
|
423
|
+
|
|
424
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
425
|
+
create_tenant_request = HatchetSdkRest::CreateTenantRequest.new({name: 'name_example', slug: 'slug_example'}) # CreateTenantRequest | The tenant to create
|
|
426
|
+
|
|
427
|
+
begin
|
|
428
|
+
# Create tenant
|
|
429
|
+
result = api_instance.tenant_create(create_tenant_request)
|
|
430
|
+
p result
|
|
431
|
+
rescue HatchetSdkRest::ApiError => e
|
|
432
|
+
puts "Error when calling TenantApi->tenant_create: #{e}"
|
|
433
|
+
end
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
#### Using the tenant_create_with_http_info variant
|
|
437
|
+
|
|
438
|
+
This returns an Array which contains the response data, status code and headers.
|
|
439
|
+
|
|
440
|
+
> <Array(<Tenant>, Integer, Hash)> tenant_create_with_http_info(create_tenant_request)
|
|
441
|
+
|
|
442
|
+
```ruby
|
|
443
|
+
begin
|
|
444
|
+
# Create tenant
|
|
445
|
+
data, status_code, headers = api_instance.tenant_create_with_http_info(create_tenant_request)
|
|
446
|
+
p status_code # => 2xx
|
|
447
|
+
p headers # => { ... }
|
|
448
|
+
p data # => <Tenant>
|
|
449
|
+
rescue HatchetSdkRest::ApiError => e
|
|
450
|
+
puts "Error when calling TenantApi->tenant_create_with_http_info: #{e}"
|
|
451
|
+
end
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
### Parameters
|
|
455
|
+
|
|
456
|
+
| Name | Type | Description | Notes |
|
|
457
|
+
| ---- | ---- | ----------- | ----- |
|
|
458
|
+
| **create_tenant_request** | [**CreateTenantRequest**](CreateTenantRequest.md) | The tenant to create | |
|
|
459
|
+
|
|
460
|
+
### Return type
|
|
461
|
+
|
|
462
|
+
[**Tenant**](Tenant.md)
|
|
463
|
+
|
|
464
|
+
### Authorization
|
|
465
|
+
|
|
466
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
467
|
+
|
|
468
|
+
### HTTP request headers
|
|
469
|
+
|
|
470
|
+
- **Content-Type**: application/json
|
|
471
|
+
- **Accept**: application/json
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
## tenant_get
|
|
475
|
+
|
|
476
|
+
> <Tenant> tenant_get(tenant)
|
|
477
|
+
|
|
478
|
+
Get tenant
|
|
479
|
+
|
|
480
|
+
Get the details of a tenant
|
|
481
|
+
|
|
482
|
+
### Examples
|
|
483
|
+
|
|
484
|
+
```ruby
|
|
485
|
+
require 'time'
|
|
486
|
+
require 'hatchet-sdk-rest'
|
|
487
|
+
# setup authorization
|
|
488
|
+
HatchetSdkRest.configure do |config|
|
|
489
|
+
# Configure API key authorization: cookieAuth
|
|
490
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
491
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
492
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
493
|
+
|
|
494
|
+
# Configure Bearer authorization: bearerAuth
|
|
495
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
496
|
+
end
|
|
497
|
+
|
|
498
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
499
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id to get details for
|
|
500
|
+
|
|
501
|
+
begin
|
|
502
|
+
# Get tenant
|
|
503
|
+
result = api_instance.tenant_get(tenant)
|
|
504
|
+
p result
|
|
505
|
+
rescue HatchetSdkRest::ApiError => e
|
|
506
|
+
puts "Error when calling TenantApi->tenant_get: #{e}"
|
|
507
|
+
end
|
|
508
|
+
```
|
|
509
|
+
|
|
510
|
+
#### Using the tenant_get_with_http_info variant
|
|
511
|
+
|
|
512
|
+
This returns an Array which contains the response data, status code and headers.
|
|
513
|
+
|
|
514
|
+
> <Array(<Tenant>, Integer, Hash)> tenant_get_with_http_info(tenant)
|
|
515
|
+
|
|
516
|
+
```ruby
|
|
517
|
+
begin
|
|
518
|
+
# Get tenant
|
|
519
|
+
data, status_code, headers = api_instance.tenant_get_with_http_info(tenant)
|
|
520
|
+
p status_code # => 2xx
|
|
521
|
+
p headers # => { ... }
|
|
522
|
+
p data # => <Tenant>
|
|
523
|
+
rescue HatchetSdkRest::ApiError => e
|
|
524
|
+
puts "Error when calling TenantApi->tenant_get_with_http_info: #{e}"
|
|
525
|
+
end
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
### Parameters
|
|
529
|
+
|
|
530
|
+
| Name | Type | Description | Notes |
|
|
531
|
+
| ---- | ---- | ----------- | ----- |
|
|
532
|
+
| **tenant** | **String** | The tenant id to get details for | |
|
|
533
|
+
|
|
534
|
+
### Return type
|
|
535
|
+
|
|
536
|
+
[**Tenant**](Tenant.md)
|
|
537
|
+
|
|
538
|
+
### Authorization
|
|
539
|
+
|
|
540
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
541
|
+
|
|
542
|
+
### HTTP request headers
|
|
543
|
+
|
|
544
|
+
- **Content-Type**: Not defined
|
|
545
|
+
- **Accept**: application/json
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
## tenant_get_prometheus_metrics
|
|
549
|
+
|
|
550
|
+
> String tenant_get_prometheus_metrics(tenant)
|
|
551
|
+
|
|
552
|
+
Get prometheus metrics
|
|
553
|
+
|
|
554
|
+
Get the prometheus metrics for the tenant
|
|
555
|
+
|
|
556
|
+
### Examples
|
|
557
|
+
|
|
558
|
+
```ruby
|
|
559
|
+
require 'time'
|
|
560
|
+
require 'hatchet-sdk-rest'
|
|
561
|
+
# setup authorization
|
|
562
|
+
HatchetSdkRest.configure do |config|
|
|
563
|
+
# Configure API key authorization: cookieAuth
|
|
564
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
565
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
566
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
567
|
+
|
|
568
|
+
# Configure Bearer authorization: bearerAuth
|
|
569
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
570
|
+
end
|
|
571
|
+
|
|
572
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
573
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
574
|
+
|
|
575
|
+
begin
|
|
576
|
+
# Get prometheus metrics
|
|
577
|
+
result = api_instance.tenant_get_prometheus_metrics(tenant)
|
|
578
|
+
p result
|
|
579
|
+
rescue HatchetSdkRest::ApiError => e
|
|
580
|
+
puts "Error when calling TenantApi->tenant_get_prometheus_metrics: #{e}"
|
|
581
|
+
end
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
#### Using the tenant_get_prometheus_metrics_with_http_info variant
|
|
585
|
+
|
|
586
|
+
This returns an Array which contains the response data, status code and headers.
|
|
587
|
+
|
|
588
|
+
> <Array(String, Integer, Hash)> tenant_get_prometheus_metrics_with_http_info(tenant)
|
|
589
|
+
|
|
590
|
+
```ruby
|
|
591
|
+
begin
|
|
592
|
+
# Get prometheus metrics
|
|
593
|
+
data, status_code, headers = api_instance.tenant_get_prometheus_metrics_with_http_info(tenant)
|
|
594
|
+
p status_code # => 2xx
|
|
595
|
+
p headers # => { ... }
|
|
596
|
+
p data # => String
|
|
597
|
+
rescue HatchetSdkRest::ApiError => e
|
|
598
|
+
puts "Error when calling TenantApi->tenant_get_prometheus_metrics_with_http_info: #{e}"
|
|
599
|
+
end
|
|
600
|
+
```
|
|
601
|
+
|
|
602
|
+
### Parameters
|
|
603
|
+
|
|
604
|
+
| Name | Type | Description | Notes |
|
|
605
|
+
| ---- | ---- | ----------- | ----- |
|
|
606
|
+
| **tenant** | **String** | The tenant id | |
|
|
607
|
+
|
|
608
|
+
### Return type
|
|
609
|
+
|
|
610
|
+
**String**
|
|
611
|
+
|
|
612
|
+
### Authorization
|
|
613
|
+
|
|
614
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
615
|
+
|
|
616
|
+
### HTTP request headers
|
|
617
|
+
|
|
618
|
+
- **Content-Type**: Not defined
|
|
619
|
+
- **Accept**: text/plain, application/json
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
## tenant_get_step_run_queue_metrics
|
|
623
|
+
|
|
624
|
+
> <TenantStepRunQueueMetrics> tenant_get_step_run_queue_metrics(tenant)
|
|
625
|
+
|
|
626
|
+
Get step run metrics
|
|
627
|
+
|
|
628
|
+
Get the queue metrics for the tenant
|
|
629
|
+
|
|
630
|
+
### Examples
|
|
631
|
+
|
|
632
|
+
```ruby
|
|
633
|
+
require 'time'
|
|
634
|
+
require 'hatchet-sdk-rest'
|
|
635
|
+
# setup authorization
|
|
636
|
+
HatchetSdkRest.configure do |config|
|
|
637
|
+
# Configure API key authorization: cookieAuth
|
|
638
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
639
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
640
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
641
|
+
|
|
642
|
+
# Configure Bearer authorization: bearerAuth
|
|
643
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
644
|
+
end
|
|
645
|
+
|
|
646
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
647
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
648
|
+
|
|
649
|
+
begin
|
|
650
|
+
# Get step run metrics
|
|
651
|
+
result = api_instance.tenant_get_step_run_queue_metrics(tenant)
|
|
652
|
+
p result
|
|
653
|
+
rescue HatchetSdkRest::ApiError => e
|
|
654
|
+
puts "Error when calling TenantApi->tenant_get_step_run_queue_metrics: #{e}"
|
|
655
|
+
end
|
|
656
|
+
```
|
|
657
|
+
|
|
658
|
+
#### Using the tenant_get_step_run_queue_metrics_with_http_info variant
|
|
659
|
+
|
|
660
|
+
This returns an Array which contains the response data, status code and headers.
|
|
661
|
+
|
|
662
|
+
> <Array(<TenantStepRunQueueMetrics>, Integer, Hash)> tenant_get_step_run_queue_metrics_with_http_info(tenant)
|
|
663
|
+
|
|
664
|
+
```ruby
|
|
665
|
+
begin
|
|
666
|
+
# Get step run metrics
|
|
667
|
+
data, status_code, headers = api_instance.tenant_get_step_run_queue_metrics_with_http_info(tenant)
|
|
668
|
+
p status_code # => 2xx
|
|
669
|
+
p headers # => { ... }
|
|
670
|
+
p data # => <TenantStepRunQueueMetrics>
|
|
671
|
+
rescue HatchetSdkRest::ApiError => e
|
|
672
|
+
puts "Error when calling TenantApi->tenant_get_step_run_queue_metrics_with_http_info: #{e}"
|
|
673
|
+
end
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
### Parameters
|
|
677
|
+
|
|
678
|
+
| Name | Type | Description | Notes |
|
|
679
|
+
| ---- | ---- | ----------- | ----- |
|
|
680
|
+
| **tenant** | **String** | The tenant id | |
|
|
681
|
+
|
|
682
|
+
### Return type
|
|
683
|
+
|
|
684
|
+
[**TenantStepRunQueueMetrics**](TenantStepRunQueueMetrics.md)
|
|
685
|
+
|
|
686
|
+
### Authorization
|
|
687
|
+
|
|
688
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
689
|
+
|
|
690
|
+
### HTTP request headers
|
|
691
|
+
|
|
692
|
+
- **Content-Type**: Not defined
|
|
693
|
+
- **Accept**: application/json
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
## tenant_invite_accept
|
|
697
|
+
|
|
698
|
+
> tenant_invite_accept(opts)
|
|
699
|
+
|
|
700
|
+
Accept tenant invite
|
|
701
|
+
|
|
702
|
+
Accepts a tenant invite
|
|
703
|
+
|
|
704
|
+
### Examples
|
|
705
|
+
|
|
706
|
+
```ruby
|
|
707
|
+
require 'time'
|
|
708
|
+
require 'hatchet-sdk-rest'
|
|
709
|
+
# setup authorization
|
|
710
|
+
HatchetSdkRest.configure do |config|
|
|
711
|
+
# Configure API key authorization: cookieAuth
|
|
712
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
713
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
714
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
715
|
+
|
|
716
|
+
# Configure Bearer authorization: bearerAuth
|
|
717
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
718
|
+
end
|
|
719
|
+
|
|
720
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
721
|
+
opts = {
|
|
722
|
+
accept_invite_request: HatchetSdkRest::AcceptInviteRequest.new({invite: 'bb214807-246e-43a5-a25d-41761d1cff9e'}) # AcceptInviteRequest |
|
|
723
|
+
}
|
|
724
|
+
|
|
725
|
+
begin
|
|
726
|
+
# Accept tenant invite
|
|
727
|
+
api_instance.tenant_invite_accept(opts)
|
|
728
|
+
rescue HatchetSdkRest::ApiError => e
|
|
729
|
+
puts "Error when calling TenantApi->tenant_invite_accept: #{e}"
|
|
730
|
+
end
|
|
731
|
+
```
|
|
732
|
+
|
|
733
|
+
#### Using the tenant_invite_accept_with_http_info variant
|
|
734
|
+
|
|
735
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
736
|
+
|
|
737
|
+
> <Array(nil, Integer, Hash)> tenant_invite_accept_with_http_info(opts)
|
|
738
|
+
|
|
739
|
+
```ruby
|
|
740
|
+
begin
|
|
741
|
+
# Accept tenant invite
|
|
742
|
+
data, status_code, headers = api_instance.tenant_invite_accept_with_http_info(opts)
|
|
743
|
+
p status_code # => 2xx
|
|
744
|
+
p headers # => { ... }
|
|
745
|
+
p data # => nil
|
|
746
|
+
rescue HatchetSdkRest::ApiError => e
|
|
747
|
+
puts "Error when calling TenantApi->tenant_invite_accept_with_http_info: #{e}"
|
|
748
|
+
end
|
|
749
|
+
```
|
|
750
|
+
|
|
751
|
+
### Parameters
|
|
752
|
+
|
|
753
|
+
| Name | Type | Description | Notes |
|
|
754
|
+
| ---- | ---- | ----------- | ----- |
|
|
755
|
+
| **accept_invite_request** | [**AcceptInviteRequest**](AcceptInviteRequest.md) | | [optional] |
|
|
756
|
+
|
|
757
|
+
### Return type
|
|
758
|
+
|
|
759
|
+
nil (empty response body)
|
|
760
|
+
|
|
761
|
+
### Authorization
|
|
762
|
+
|
|
763
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
764
|
+
|
|
765
|
+
### HTTP request headers
|
|
766
|
+
|
|
767
|
+
- **Content-Type**: application/json
|
|
768
|
+
- **Accept**: application/json
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
## tenant_invite_create
|
|
772
|
+
|
|
773
|
+
> <TenantInvite> tenant_invite_create(tenant, create_tenant_invite_request)
|
|
774
|
+
|
|
775
|
+
Create tenant invite
|
|
776
|
+
|
|
777
|
+
Creates a new tenant invite
|
|
778
|
+
|
|
779
|
+
### Examples
|
|
780
|
+
|
|
781
|
+
```ruby
|
|
782
|
+
require 'time'
|
|
783
|
+
require 'hatchet-sdk-rest'
|
|
784
|
+
# setup authorization
|
|
785
|
+
HatchetSdkRest.configure do |config|
|
|
786
|
+
# Configure API key authorization: cookieAuth
|
|
787
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
788
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
789
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
790
|
+
|
|
791
|
+
# Configure Bearer authorization: bearerAuth
|
|
792
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
793
|
+
end
|
|
794
|
+
|
|
795
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
796
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
797
|
+
create_tenant_invite_request = HatchetSdkRest::CreateTenantInviteRequest.new({email: 'email_example', role: HatchetSdkRest::TenantMemberRole::OWNER}) # CreateTenantInviteRequest | The tenant invite to create
|
|
798
|
+
|
|
799
|
+
begin
|
|
800
|
+
# Create tenant invite
|
|
801
|
+
result = api_instance.tenant_invite_create(tenant, create_tenant_invite_request)
|
|
802
|
+
p result
|
|
803
|
+
rescue HatchetSdkRest::ApiError => e
|
|
804
|
+
puts "Error when calling TenantApi->tenant_invite_create: #{e}"
|
|
805
|
+
end
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
#### Using the tenant_invite_create_with_http_info variant
|
|
809
|
+
|
|
810
|
+
This returns an Array which contains the response data, status code and headers.
|
|
811
|
+
|
|
812
|
+
> <Array(<TenantInvite>, Integer, Hash)> tenant_invite_create_with_http_info(tenant, create_tenant_invite_request)
|
|
813
|
+
|
|
814
|
+
```ruby
|
|
815
|
+
begin
|
|
816
|
+
# Create tenant invite
|
|
817
|
+
data, status_code, headers = api_instance.tenant_invite_create_with_http_info(tenant, create_tenant_invite_request)
|
|
818
|
+
p status_code # => 2xx
|
|
819
|
+
p headers # => { ... }
|
|
820
|
+
p data # => <TenantInvite>
|
|
821
|
+
rescue HatchetSdkRest::ApiError => e
|
|
822
|
+
puts "Error when calling TenantApi->tenant_invite_create_with_http_info: #{e}"
|
|
823
|
+
end
|
|
824
|
+
```
|
|
825
|
+
|
|
826
|
+
### Parameters
|
|
827
|
+
|
|
828
|
+
| Name | Type | Description | Notes |
|
|
829
|
+
| ---- | ---- | ----------- | ----- |
|
|
830
|
+
| **tenant** | **String** | The tenant id | |
|
|
831
|
+
| **create_tenant_invite_request** | [**CreateTenantInviteRequest**](CreateTenantInviteRequest.md) | The tenant invite to create | |
|
|
832
|
+
|
|
833
|
+
### Return type
|
|
834
|
+
|
|
835
|
+
[**TenantInvite**](TenantInvite.md)
|
|
836
|
+
|
|
837
|
+
### Authorization
|
|
838
|
+
|
|
839
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
840
|
+
|
|
841
|
+
### HTTP request headers
|
|
842
|
+
|
|
843
|
+
- **Content-Type**: application/json
|
|
844
|
+
- **Accept**: application/json
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
## tenant_invite_list
|
|
848
|
+
|
|
849
|
+
> <TenantInviteList> tenant_invite_list(tenant)
|
|
850
|
+
|
|
851
|
+
List tenant invites
|
|
852
|
+
|
|
853
|
+
Gets a list of tenant invites
|
|
854
|
+
|
|
855
|
+
### Examples
|
|
856
|
+
|
|
857
|
+
```ruby
|
|
858
|
+
require 'time'
|
|
859
|
+
require 'hatchet-sdk-rest'
|
|
860
|
+
# setup authorization
|
|
861
|
+
HatchetSdkRest.configure do |config|
|
|
862
|
+
# Configure API key authorization: cookieAuth
|
|
863
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
864
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
865
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
866
|
+
|
|
867
|
+
# Configure Bearer authorization: bearerAuth
|
|
868
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
869
|
+
end
|
|
870
|
+
|
|
871
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
872
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
873
|
+
|
|
874
|
+
begin
|
|
875
|
+
# List tenant invites
|
|
876
|
+
result = api_instance.tenant_invite_list(tenant)
|
|
877
|
+
p result
|
|
878
|
+
rescue HatchetSdkRest::ApiError => e
|
|
879
|
+
puts "Error when calling TenantApi->tenant_invite_list: #{e}"
|
|
880
|
+
end
|
|
881
|
+
```
|
|
882
|
+
|
|
883
|
+
#### Using the tenant_invite_list_with_http_info variant
|
|
884
|
+
|
|
885
|
+
This returns an Array which contains the response data, status code and headers.
|
|
886
|
+
|
|
887
|
+
> <Array(<TenantInviteList>, Integer, Hash)> tenant_invite_list_with_http_info(tenant)
|
|
888
|
+
|
|
889
|
+
```ruby
|
|
890
|
+
begin
|
|
891
|
+
# List tenant invites
|
|
892
|
+
data, status_code, headers = api_instance.tenant_invite_list_with_http_info(tenant)
|
|
893
|
+
p status_code # => 2xx
|
|
894
|
+
p headers # => { ... }
|
|
895
|
+
p data # => <TenantInviteList>
|
|
896
|
+
rescue HatchetSdkRest::ApiError => e
|
|
897
|
+
puts "Error when calling TenantApi->tenant_invite_list_with_http_info: #{e}"
|
|
898
|
+
end
|
|
899
|
+
```
|
|
900
|
+
|
|
901
|
+
### Parameters
|
|
902
|
+
|
|
903
|
+
| Name | Type | Description | Notes |
|
|
904
|
+
| ---- | ---- | ----------- | ----- |
|
|
905
|
+
| **tenant** | **String** | The tenant id | |
|
|
906
|
+
|
|
907
|
+
### Return type
|
|
908
|
+
|
|
909
|
+
[**TenantInviteList**](TenantInviteList.md)
|
|
910
|
+
|
|
911
|
+
### Authorization
|
|
912
|
+
|
|
913
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
914
|
+
|
|
915
|
+
### HTTP request headers
|
|
916
|
+
|
|
917
|
+
- **Content-Type**: Not defined
|
|
918
|
+
- **Accept**: application/json
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
## tenant_invite_reject
|
|
922
|
+
|
|
923
|
+
> tenant_invite_reject(opts)
|
|
924
|
+
|
|
925
|
+
Reject tenant invite
|
|
926
|
+
|
|
927
|
+
Rejects a tenant invite
|
|
928
|
+
|
|
929
|
+
### Examples
|
|
930
|
+
|
|
931
|
+
```ruby
|
|
932
|
+
require 'time'
|
|
933
|
+
require 'hatchet-sdk-rest'
|
|
934
|
+
# setup authorization
|
|
935
|
+
HatchetSdkRest.configure do |config|
|
|
936
|
+
# Configure API key authorization: cookieAuth
|
|
937
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
938
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
939
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
940
|
+
|
|
941
|
+
# Configure Bearer authorization: bearerAuth
|
|
942
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
943
|
+
end
|
|
944
|
+
|
|
945
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
946
|
+
opts = {
|
|
947
|
+
reject_invite_request: HatchetSdkRest::RejectInviteRequest.new({invite: 'bb214807-246e-43a5-a25d-41761d1cff9e'}) # RejectInviteRequest |
|
|
948
|
+
}
|
|
949
|
+
|
|
950
|
+
begin
|
|
951
|
+
# Reject tenant invite
|
|
952
|
+
api_instance.tenant_invite_reject(opts)
|
|
953
|
+
rescue HatchetSdkRest::ApiError => e
|
|
954
|
+
puts "Error when calling TenantApi->tenant_invite_reject: #{e}"
|
|
955
|
+
end
|
|
956
|
+
```
|
|
957
|
+
|
|
958
|
+
#### Using the tenant_invite_reject_with_http_info variant
|
|
959
|
+
|
|
960
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
961
|
+
|
|
962
|
+
> <Array(nil, Integer, Hash)> tenant_invite_reject_with_http_info(opts)
|
|
963
|
+
|
|
964
|
+
```ruby
|
|
965
|
+
begin
|
|
966
|
+
# Reject tenant invite
|
|
967
|
+
data, status_code, headers = api_instance.tenant_invite_reject_with_http_info(opts)
|
|
968
|
+
p status_code # => 2xx
|
|
969
|
+
p headers # => { ... }
|
|
970
|
+
p data # => nil
|
|
971
|
+
rescue HatchetSdkRest::ApiError => e
|
|
972
|
+
puts "Error when calling TenantApi->tenant_invite_reject_with_http_info: #{e}"
|
|
973
|
+
end
|
|
974
|
+
```
|
|
975
|
+
|
|
976
|
+
### Parameters
|
|
977
|
+
|
|
978
|
+
| Name | Type | Description | Notes |
|
|
979
|
+
| ---- | ---- | ----------- | ----- |
|
|
980
|
+
| **reject_invite_request** | [**RejectInviteRequest**](RejectInviteRequest.md) | | [optional] |
|
|
981
|
+
|
|
982
|
+
### Return type
|
|
983
|
+
|
|
984
|
+
nil (empty response body)
|
|
985
|
+
|
|
986
|
+
### Authorization
|
|
987
|
+
|
|
988
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
989
|
+
|
|
990
|
+
### HTTP request headers
|
|
991
|
+
|
|
992
|
+
- **Content-Type**: application/json
|
|
993
|
+
- **Accept**: application/json
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
## tenant_member_delete
|
|
997
|
+
|
|
998
|
+
> <TenantMember> tenant_member_delete(tenant, member)
|
|
999
|
+
|
|
1000
|
+
Delete a tenant member
|
|
1001
|
+
|
|
1002
|
+
Delete a member from a tenant
|
|
1003
|
+
|
|
1004
|
+
### Examples
|
|
1005
|
+
|
|
1006
|
+
```ruby
|
|
1007
|
+
require 'time'
|
|
1008
|
+
require 'hatchet-sdk-rest'
|
|
1009
|
+
# setup authorization
|
|
1010
|
+
HatchetSdkRest.configure do |config|
|
|
1011
|
+
# Configure API key authorization: cookieAuth
|
|
1012
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
1013
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1014
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
1015
|
+
|
|
1016
|
+
# Configure Bearer authorization: bearerAuth
|
|
1017
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1018
|
+
end
|
|
1019
|
+
|
|
1020
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
1021
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
1022
|
+
member = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant member id
|
|
1023
|
+
|
|
1024
|
+
begin
|
|
1025
|
+
# Delete a tenant member
|
|
1026
|
+
result = api_instance.tenant_member_delete(tenant, member)
|
|
1027
|
+
p result
|
|
1028
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1029
|
+
puts "Error when calling TenantApi->tenant_member_delete: #{e}"
|
|
1030
|
+
end
|
|
1031
|
+
```
|
|
1032
|
+
|
|
1033
|
+
#### Using the tenant_member_delete_with_http_info variant
|
|
1034
|
+
|
|
1035
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1036
|
+
|
|
1037
|
+
> <Array(<TenantMember>, Integer, Hash)> tenant_member_delete_with_http_info(tenant, member)
|
|
1038
|
+
|
|
1039
|
+
```ruby
|
|
1040
|
+
begin
|
|
1041
|
+
# Delete a tenant member
|
|
1042
|
+
data, status_code, headers = api_instance.tenant_member_delete_with_http_info(tenant, member)
|
|
1043
|
+
p status_code # => 2xx
|
|
1044
|
+
p headers # => { ... }
|
|
1045
|
+
p data # => <TenantMember>
|
|
1046
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1047
|
+
puts "Error when calling TenantApi->tenant_member_delete_with_http_info: #{e}"
|
|
1048
|
+
end
|
|
1049
|
+
```
|
|
1050
|
+
|
|
1051
|
+
### Parameters
|
|
1052
|
+
|
|
1053
|
+
| Name | Type | Description | Notes |
|
|
1054
|
+
| ---- | ---- | ----------- | ----- |
|
|
1055
|
+
| **tenant** | **String** | The tenant id | |
|
|
1056
|
+
| **member** | **String** | The tenant member id | |
|
|
1057
|
+
|
|
1058
|
+
### Return type
|
|
1059
|
+
|
|
1060
|
+
[**TenantMember**](TenantMember.md)
|
|
1061
|
+
|
|
1062
|
+
### Authorization
|
|
1063
|
+
|
|
1064
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
1065
|
+
|
|
1066
|
+
### HTTP request headers
|
|
1067
|
+
|
|
1068
|
+
- **Content-Type**: Not defined
|
|
1069
|
+
- **Accept**: application/json
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
## tenant_member_list
|
|
1073
|
+
|
|
1074
|
+
> <TenantMemberList> tenant_member_list(tenant)
|
|
1075
|
+
|
|
1076
|
+
List tenant members
|
|
1077
|
+
|
|
1078
|
+
Gets a list of tenant members
|
|
1079
|
+
|
|
1080
|
+
### Examples
|
|
1081
|
+
|
|
1082
|
+
```ruby
|
|
1083
|
+
require 'time'
|
|
1084
|
+
require 'hatchet-sdk-rest'
|
|
1085
|
+
# setup authorization
|
|
1086
|
+
HatchetSdkRest.configure do |config|
|
|
1087
|
+
# Configure API key authorization: cookieAuth
|
|
1088
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
1089
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1090
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
1091
|
+
|
|
1092
|
+
# Configure Bearer authorization: bearerAuth
|
|
1093
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1094
|
+
end
|
|
1095
|
+
|
|
1096
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
1097
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
1098
|
+
|
|
1099
|
+
begin
|
|
1100
|
+
# List tenant members
|
|
1101
|
+
result = api_instance.tenant_member_list(tenant)
|
|
1102
|
+
p result
|
|
1103
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1104
|
+
puts "Error when calling TenantApi->tenant_member_list: #{e}"
|
|
1105
|
+
end
|
|
1106
|
+
```
|
|
1107
|
+
|
|
1108
|
+
#### Using the tenant_member_list_with_http_info variant
|
|
1109
|
+
|
|
1110
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1111
|
+
|
|
1112
|
+
> <Array(<TenantMemberList>, Integer, Hash)> tenant_member_list_with_http_info(tenant)
|
|
1113
|
+
|
|
1114
|
+
```ruby
|
|
1115
|
+
begin
|
|
1116
|
+
# List tenant members
|
|
1117
|
+
data, status_code, headers = api_instance.tenant_member_list_with_http_info(tenant)
|
|
1118
|
+
p status_code # => 2xx
|
|
1119
|
+
p headers # => { ... }
|
|
1120
|
+
p data # => <TenantMemberList>
|
|
1121
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1122
|
+
puts "Error when calling TenantApi->tenant_member_list_with_http_info: #{e}"
|
|
1123
|
+
end
|
|
1124
|
+
```
|
|
1125
|
+
|
|
1126
|
+
### Parameters
|
|
1127
|
+
|
|
1128
|
+
| Name | Type | Description | Notes |
|
|
1129
|
+
| ---- | ---- | ----------- | ----- |
|
|
1130
|
+
| **tenant** | **String** | The tenant id | |
|
|
1131
|
+
|
|
1132
|
+
### Return type
|
|
1133
|
+
|
|
1134
|
+
[**TenantMemberList**](TenantMemberList.md)
|
|
1135
|
+
|
|
1136
|
+
### Authorization
|
|
1137
|
+
|
|
1138
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
1139
|
+
|
|
1140
|
+
### HTTP request headers
|
|
1141
|
+
|
|
1142
|
+
- **Content-Type**: Not defined
|
|
1143
|
+
- **Accept**: application/json
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
## tenant_resource_policy_get
|
|
1147
|
+
|
|
1148
|
+
> <TenantResourcePolicy> tenant_resource_policy_get(tenant)
|
|
1149
|
+
|
|
1150
|
+
Create tenant alert email group
|
|
1151
|
+
|
|
1152
|
+
Gets the resource policy for a tenant
|
|
1153
|
+
|
|
1154
|
+
### Examples
|
|
1155
|
+
|
|
1156
|
+
```ruby
|
|
1157
|
+
require 'time'
|
|
1158
|
+
require 'hatchet-sdk-rest'
|
|
1159
|
+
# setup authorization
|
|
1160
|
+
HatchetSdkRest.configure do |config|
|
|
1161
|
+
# Configure API key authorization: cookieAuth
|
|
1162
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
1163
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1164
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
1165
|
+
|
|
1166
|
+
# Configure Bearer authorization: bearerAuth
|
|
1167
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1168
|
+
end
|
|
1169
|
+
|
|
1170
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
1171
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
1172
|
+
|
|
1173
|
+
begin
|
|
1174
|
+
# Create tenant alert email group
|
|
1175
|
+
result = api_instance.tenant_resource_policy_get(tenant)
|
|
1176
|
+
p result
|
|
1177
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1178
|
+
puts "Error when calling TenantApi->tenant_resource_policy_get: #{e}"
|
|
1179
|
+
end
|
|
1180
|
+
```
|
|
1181
|
+
|
|
1182
|
+
#### Using the tenant_resource_policy_get_with_http_info variant
|
|
1183
|
+
|
|
1184
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1185
|
+
|
|
1186
|
+
> <Array(<TenantResourcePolicy>, Integer, Hash)> tenant_resource_policy_get_with_http_info(tenant)
|
|
1187
|
+
|
|
1188
|
+
```ruby
|
|
1189
|
+
begin
|
|
1190
|
+
# Create tenant alert email group
|
|
1191
|
+
data, status_code, headers = api_instance.tenant_resource_policy_get_with_http_info(tenant)
|
|
1192
|
+
p status_code # => 2xx
|
|
1193
|
+
p headers # => { ... }
|
|
1194
|
+
p data # => <TenantResourcePolicy>
|
|
1195
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1196
|
+
puts "Error when calling TenantApi->tenant_resource_policy_get_with_http_info: #{e}"
|
|
1197
|
+
end
|
|
1198
|
+
```
|
|
1199
|
+
|
|
1200
|
+
### Parameters
|
|
1201
|
+
|
|
1202
|
+
| Name | Type | Description | Notes |
|
|
1203
|
+
| ---- | ---- | ----------- | ----- |
|
|
1204
|
+
| **tenant** | **String** | The tenant id | |
|
|
1205
|
+
|
|
1206
|
+
### Return type
|
|
1207
|
+
|
|
1208
|
+
[**TenantResourcePolicy**](TenantResourcePolicy.md)
|
|
1209
|
+
|
|
1210
|
+
### Authorization
|
|
1211
|
+
|
|
1212
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
1213
|
+
|
|
1214
|
+
### HTTP request headers
|
|
1215
|
+
|
|
1216
|
+
- **Content-Type**: Not defined
|
|
1217
|
+
- **Accept**: application/json
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
## tenant_update
|
|
1221
|
+
|
|
1222
|
+
> <Tenant> tenant_update(tenant, update_tenant_request)
|
|
1223
|
+
|
|
1224
|
+
Update tenant
|
|
1225
|
+
|
|
1226
|
+
Update an existing tenant
|
|
1227
|
+
|
|
1228
|
+
### Examples
|
|
1229
|
+
|
|
1230
|
+
```ruby
|
|
1231
|
+
require 'time'
|
|
1232
|
+
require 'hatchet-sdk-rest'
|
|
1233
|
+
# setup authorization
|
|
1234
|
+
HatchetSdkRest.configure do |config|
|
|
1235
|
+
# Configure API key authorization: cookieAuth
|
|
1236
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
1237
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1238
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
1239
|
+
|
|
1240
|
+
# Configure Bearer authorization: bearerAuth
|
|
1241
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1242
|
+
end
|
|
1243
|
+
|
|
1244
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
1245
|
+
tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
|
|
1246
|
+
update_tenant_request = HatchetSdkRest::UpdateTenantRequest.new # UpdateTenantRequest | The tenant properties to update
|
|
1247
|
+
|
|
1248
|
+
begin
|
|
1249
|
+
# Update tenant
|
|
1250
|
+
result = api_instance.tenant_update(tenant, update_tenant_request)
|
|
1251
|
+
p result
|
|
1252
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1253
|
+
puts "Error when calling TenantApi->tenant_update: #{e}"
|
|
1254
|
+
end
|
|
1255
|
+
```
|
|
1256
|
+
|
|
1257
|
+
#### Using the tenant_update_with_http_info variant
|
|
1258
|
+
|
|
1259
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1260
|
+
|
|
1261
|
+
> <Array(<Tenant>, Integer, Hash)> tenant_update_with_http_info(tenant, update_tenant_request)
|
|
1262
|
+
|
|
1263
|
+
```ruby
|
|
1264
|
+
begin
|
|
1265
|
+
# Update tenant
|
|
1266
|
+
data, status_code, headers = api_instance.tenant_update_with_http_info(tenant, update_tenant_request)
|
|
1267
|
+
p status_code # => 2xx
|
|
1268
|
+
p headers # => { ... }
|
|
1269
|
+
p data # => <Tenant>
|
|
1270
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1271
|
+
puts "Error when calling TenantApi->tenant_update_with_http_info: #{e}"
|
|
1272
|
+
end
|
|
1273
|
+
```
|
|
1274
|
+
|
|
1275
|
+
### Parameters
|
|
1276
|
+
|
|
1277
|
+
| Name | Type | Description | Notes |
|
|
1278
|
+
| ---- | ---- | ----------- | ----- |
|
|
1279
|
+
| **tenant** | **String** | The tenant id | |
|
|
1280
|
+
| **update_tenant_request** | [**UpdateTenantRequest**](UpdateTenantRequest.md) | The tenant properties to update | |
|
|
1281
|
+
|
|
1282
|
+
### Return type
|
|
1283
|
+
|
|
1284
|
+
[**Tenant**](Tenant.md)
|
|
1285
|
+
|
|
1286
|
+
### Authorization
|
|
1287
|
+
|
|
1288
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
1289
|
+
|
|
1290
|
+
### HTTP request headers
|
|
1291
|
+
|
|
1292
|
+
- **Content-Type**: application/json
|
|
1293
|
+
- **Accept**: application/json
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
## user_list_tenant_invites
|
|
1297
|
+
|
|
1298
|
+
> <TenantInviteList> user_list_tenant_invites
|
|
1299
|
+
|
|
1300
|
+
List tenant invites
|
|
1301
|
+
|
|
1302
|
+
Lists all tenant invites for the current user
|
|
1303
|
+
|
|
1304
|
+
### Examples
|
|
1305
|
+
|
|
1306
|
+
```ruby
|
|
1307
|
+
require 'time'
|
|
1308
|
+
require 'hatchet-sdk-rest'
|
|
1309
|
+
# setup authorization
|
|
1310
|
+
HatchetSdkRest.configure do |config|
|
|
1311
|
+
# Configure API key authorization: cookieAuth
|
|
1312
|
+
config.api_key['hatchet'] = 'YOUR API KEY'
|
|
1313
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1314
|
+
# config.api_key_prefix['hatchet'] = 'Bearer'
|
|
1315
|
+
end
|
|
1316
|
+
|
|
1317
|
+
api_instance = HatchetSdkRest::TenantApi.new
|
|
1318
|
+
|
|
1319
|
+
begin
|
|
1320
|
+
# List tenant invites
|
|
1321
|
+
result = api_instance.user_list_tenant_invites
|
|
1322
|
+
p result
|
|
1323
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1324
|
+
puts "Error when calling TenantApi->user_list_tenant_invites: #{e}"
|
|
1325
|
+
end
|
|
1326
|
+
```
|
|
1327
|
+
|
|
1328
|
+
#### Using the user_list_tenant_invites_with_http_info variant
|
|
1329
|
+
|
|
1330
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1331
|
+
|
|
1332
|
+
> <Array(<TenantInviteList>, Integer, Hash)> user_list_tenant_invites_with_http_info
|
|
1333
|
+
|
|
1334
|
+
```ruby
|
|
1335
|
+
begin
|
|
1336
|
+
# List tenant invites
|
|
1337
|
+
data, status_code, headers = api_instance.user_list_tenant_invites_with_http_info
|
|
1338
|
+
p status_code # => 2xx
|
|
1339
|
+
p headers # => { ... }
|
|
1340
|
+
p data # => <TenantInviteList>
|
|
1341
|
+
rescue HatchetSdkRest::ApiError => e
|
|
1342
|
+
puts "Error when calling TenantApi->user_list_tenant_invites_with_http_info: #{e}"
|
|
1343
|
+
end
|
|
1344
|
+
```
|
|
1345
|
+
|
|
1346
|
+
### Parameters
|
|
1347
|
+
|
|
1348
|
+
This endpoint does not need any parameter.
|
|
1349
|
+
|
|
1350
|
+
### Return type
|
|
1351
|
+
|
|
1352
|
+
[**TenantInviteList**](TenantInviteList.md)
|
|
1353
|
+
|
|
1354
|
+
### Authorization
|
|
1355
|
+
|
|
1356
|
+
[cookieAuth](../README.md#cookieAuth)
|
|
1357
|
+
|
|
1358
|
+
### HTTP request headers
|
|
1359
|
+
|
|
1360
|
+
- **Content-Type**: Not defined
|
|
1361
|
+
- **Accept**: application/json
|
|
1362
|
+
|