api.md

Shared

Types:

• AutomationTrigger
• EnvironmentClass
• ErrorCode
• FieldValue
• OrganizationRole
• Principal
• RunsOn
• Subject
• Task
• TaskExecution
• TaskExecutionMetadata
• TaskExecutionPhase
• TaskExecutionSpec
• TaskExecutionStatus
• TaskMetadata
• TaskSpec
• UserStatus

Accounts

Types:

• Account
• AccountMembership
• JoinableOrganization
• LoginProvider
• AccountRetrieveResponse
• AccountDeleteResponse
• AccountGetSSOLoginURLResponse

Methods:

• client.accounts.retrieve({ ...params }) -> AccountRetrieveResponse
• client.accounts.delete({ ...params }) -> unknown
• client.accounts.getSSOLoginURL({ ...params }) -> AccountGetSSOLoginURLResponse
• client.accounts.listLoginProviders({ ...params }) -> LoginProvidersLoginProvidersPage

Editors

Types:

• Editor
• EditorRetrieveResponse
• EditorResolveURLResponse

Methods:

• client.editors.retrieve({ ...params }) -> EditorRetrieveResponse
• client.editors.list({ ...params }) -> EditorsEditorsPage
• client.editors.resolveURL({ ...params }) -> EditorResolveURLResponse

Environments

Types:

• AdmissionLevel
• Environment
• EnvironmentActivitySignal
• EnvironmentMetadata
• EnvironmentPhase
• EnvironmentSpec
• EnvironmentStatus
• EnvironmentCreateResponse
• EnvironmentRetrieveResponse
• EnvironmentUpdateResponse
• EnvironmentDeleteResponse
• EnvironmentCreateFromProjectResponse
• EnvironmentCreateLogsTokenResponse
• EnvironmentMarkActiveResponse
• EnvironmentStartResponse
• EnvironmentStopResponse

Methods:

• client.environments.create({ ...params }) -> EnvironmentCreateResponse
• client.environments.retrieve({ ...params }) -> EnvironmentRetrieveResponse
• client.environments.update({ ...params }) -> unknown
• client.environments.list({ ...params }) -> EnvironmentsEnvironmentsPage
• client.environments.delete({ ...params }) -> unknown
• client.environments.createFromProject({ ...params }) -> EnvironmentCreateFromProjectResponse
• client.environments.createLogsToken({ ...params }) -> EnvironmentCreateLogsTokenResponse
• client.environments.markActive({ ...params }) -> unknown
• client.environments.start({ ...params }) -> unknown
• client.environments.stop({ ...params }) -> unknown

Automations

Types:

• AutomationsFile
• AutomationUpsertResponse

Methods:

• client.environments.automations.upsert({ ...params }) -> AutomationUpsertResponse

Services

Types:

• Service
• ServiceMetadata
• ServicePhase
• ServiceSpec
• ServiceStatus
• ServiceCreateResponse
• ServiceRetrieveResponse
• ServiceUpdateResponse
• ServiceDeleteResponse
• ServiceStartResponse
• ServiceStopResponse

Methods:

• client.environments.automations.services.create({ ...params }) -> ServiceCreateResponse
• client.environments.automations.services.retrieve({ ...params }) -> ServiceRetrieveResponse
• client.environments.automations.services.update({ ...params }) -> unknown
• client.environments.automations.services.list({ ...params }) -> ServicesServicesPage
• client.environments.automations.services.delete({ ...params }) -> unknown
• client.environments.automations.services.start({ ...params }) -> unknown
• client.environments.automations.services.stop({ ...params }) -> unknown

Tasks

Types:

• TaskCreateResponse
• TaskRetrieveResponse
• TaskUpdateResponse
• TaskDeleteResponse
• TaskStartResponse

Methods:

• client.environments.automations.tasks.create({ ...params }) -> TaskCreateResponse
• client.environments.automations.tasks.retrieve({ ...params }) -> TaskRetrieveResponse
• client.environments.automations.tasks.update({ ...params }) -> unknown
• client.environments.automations.tasks.list({ ...params }) -> TasksTasksPage
• client.environments.automations.tasks.delete({ ...params }) -> unknown
• client.environments.automations.tasks.start({ ...params }) -> TaskStartResponse

Executions

Types:

• ExecutionRetrieveResponse
• ExecutionStopResponse

Methods:

• client.environments.automations.tasks.executions.retrieve({ ...params }) -> ExecutionRetrieveResponse
• client.environments.automations.tasks.executions.list({ ...params }) -> TaskExecutionsTaskExecutionsPage
• client.environments.automations.tasks.executions.stop({ ...params }) -> unknown

Classes

Methods:

• client.environments.classes.list({ ...params }) -> EnvironmentClassesEnvironmentClassesPage

Events

Types:

• ResourceOperation
• ResourceType
• EventListResponse
• EventWatchResponse

Methods:

• client.events.list({ ...params }) -> EventListResponsesEntriesPage
• client.events.watch({ ...params }) -> JSONLDecoder<EventWatchResponse>

Groups

Types:

• Group

Methods:

• client.groups.list({ ...params }) -> GroupsGroupsPage

Identity

Types:

• IdentityExchangeTokenResponse
• IdentityGetAuthenticatedIdentityResponse
• IdentityGetIDTokenResponse

Methods:

• client.identity.exchangeToken({ ...params }) -> IdentityExchangeTokenResponse
• client.identity.getAuthenticatedIdentity({ ...params }) -> IdentityGetAuthenticatedIdentityResponse
• client.identity.getIDToken({ ...params }) -> IdentityGetIDTokenResponse

Organizations

Types:

• InviteDomains
• Organization
• OrganizationMember
• Scope
• OrganizationCreateResponse
• OrganizationRetrieveResponse
• OrganizationUpdateResponse
• OrganizationDeleteResponse
• OrganizationJoinResponse
• OrganizationLeaveResponse
• OrganizationSetRoleResponse

Methods:

• client.organizations.create({ ...params }) -> OrganizationCreateResponse
• client.organizations.retrieve({ ...params }) -> OrganizationRetrieveResponse
• client.organizations.update({ ...params }) -> OrganizationUpdateResponse
• client.organizations.list({ ...params }) -> OrganizationsOrganizationsPage
• client.organizations.delete({ ...params }) -> unknown
• client.organizations.join({ ...params }) -> OrganizationJoinResponse
• client.organizations.leave({ ...params }) -> unknown
• client.organizations.listMembers({ ...params }) -> OrganizationMembersMembersPage
• client.organizations.setRole({ ...params }) -> unknown

DomainVerifications

Types:

• DomainVerification
• DomainVerificationState
• DomainVerificationCreateResponse
• DomainVerificationRetrieveResponse
• DomainVerificationDeleteResponse
• DomainVerificationVerifyResponse

Methods:

• client.organizations.domainVerifications.create({ ...params }) -> DomainVerificationCreateResponse
• client.organizations.domainVerifications.retrieve({ ...params }) -> DomainVerificationRetrieveResponse
• client.organizations.domainVerifications.list({ ...params }) -> DomainVerificationsDomainVerificationsPage
• client.organizations.domainVerifications.delete({ ...params }) -> unknown
• client.organizations.domainVerifications.verify({ ...params }) -> DomainVerificationVerifyResponse

Invites

Types:

• OrganizationInvite
• InviteCreateResponse
• InviteRetrieveResponse
• InviteGetSummaryResponse

Methods:

• client.organizations.invites.create({ ...params }) -> InviteCreateResponse
• client.organizations.invites.retrieve({ ...params }) -> InviteRetrieveResponse
• client.organizations.invites.getSummary({ ...params }) -> InviteGetSummaryResponse

SSOConfigurations

Types:

• ProviderType
• SSOConfiguration
• SSOConfigurationState
• SSOConfigurationCreateResponse
• SSOConfigurationRetrieveResponse
• SSOConfigurationUpdateResponse
• SSOConfigurationDeleteResponse

Methods:

• client.organizations.ssoConfigurations.create({ ...params }) -> SSOConfigurationCreateResponse
• client.organizations.ssoConfigurations.retrieve({ ...params }) -> SSOConfigurationRetrieveResponse
• client.organizations.ssoConfigurations.update({ ...params }) -> unknown
• client.organizations.ssoConfigurations.list({ ...params }) -> SSOConfigurationsSSOConfigurationsPage
• client.organizations.ssoConfigurations.delete({ ...params }) -> unknown

Projects

Types:

• EnvironmentInitializer
• Project
• ProjectEnvironmentClass
• ProjectMetadata
• ProjectCreateResponse
• ProjectRetrieveResponse
• ProjectUpdateResponse
• ProjectDeleteResponse
• ProjectCreateFromEnvironmentResponse

Methods:

• client.projects.create({ ...params }) -> ProjectCreateResponse
• client.projects.retrieve({ ...params }) -> ProjectRetrieveResponse
• client.projects.update({ ...params }) -> ProjectUpdateResponse
• client.projects.list({ ...params }) -> ProjectsProjectsPage
• client.projects.delete({ ...params }) -> unknown
• client.projects.createFromEnvironment({ ...params }) -> ProjectCreateFromEnvironmentResponse

Policies

Types:

• ProjectPolicy
• ProjectRole
• PolicyCreateResponse
• PolicyUpdateResponse
• PolicyDeleteResponse

Methods:

• client.projects.policies.create({ ...params }) -> PolicyCreateResponse
• client.projects.policies.update({ ...params }) -> PolicyUpdateResponse
• client.projects.policies.list({ ...params }) -> ProjectPoliciesPoliciesPage
• client.projects.policies.delete({ ...params }) -> unknown

Runners

Types:

• Runner
• RunnerCapability
• RunnerConfiguration
• RunnerKind
• RunnerPhase
• RunnerProvider
• RunnerReleaseChannel
• RunnerSpec
• RunnerStatus
• RunnerCreateResponse
• RunnerRetrieveResponse
• RunnerUpdateResponse
• RunnerDeleteResponse
• RunnerCheckAuthenticationForHostResponse
• RunnerCreateRunnerTokenResponse
• RunnerParseContextURLResponse

Methods:

• client.runners.create({ ...params }) -> RunnerCreateResponse
• client.runners.retrieve({ ...params }) -> RunnerRetrieveResponse
• client.runners.update({ ...params }) -> unknown
• client.runners.list({ ...params }) -> RunnersRunnersPage
• client.runners.delete({ ...params }) -> unknown
• client.runners.checkAuthenticationForHost({ ...params }) -> RunnerCheckAuthenticationForHostResponse
• client.runners.createRunnerToken({ ...params }) -> RunnerCreateRunnerTokenResponse
• client.runners.parseContextURL({ ...params }) -> RunnerParseContextURLResponse

Configurations

Types:

• EnvironmentClassValidationResult
• FieldValidationError
• ScmIntegrationValidationResult
• ConfigurationValidateResponse

Methods:

• client.runners.configurations.validate({ ...params }) -> ConfigurationValidateResponse

EnvironmentClasses

Types:

• EnvironmentClassCreateResponse
• EnvironmentClassRetrieveResponse
• EnvironmentClassUpdateResponse

Methods:

• client.runners.configurations.environmentClasses.create({ ...params }) -> EnvironmentClassCreateResponse
• client.runners.configurations.environmentClasses.retrieve({ ...params }) -> EnvironmentClassRetrieveResponse
• client.runners.configurations.environmentClasses.update({ ...params }) -> unknown
• client.runners.configurations.environmentClasses.list({ ...params }) -> EnvironmentClassesEnvironmentClassesPage

HostAuthenticationTokens

Types:

• HostAuthenticationToken
• HostAuthenticationTokenSource
• HostAuthenticationTokenCreateResponse
• HostAuthenticationTokenRetrieveResponse
• HostAuthenticationTokenUpdateResponse
• HostAuthenticationTokenDeleteResponse

Methods:

• client.runners.configurations.hostAuthenticationTokens.create({ ...params }) -> HostAuthenticationTokenCreateResponse
• client.runners.configurations.hostAuthenticationTokens.retrieve({ ...params }) -> HostAuthenticationTokenRetrieveResponse
• client.runners.configurations.hostAuthenticationTokens.update({ ...params }) -> unknown
• client.runners.configurations.hostAuthenticationTokens.list({ ...params }) -> HostAuthenticationTokensTokensPage
• client.runners.configurations.hostAuthenticationTokens.delete({ ...params }) -> unknown

Schema

Types:

• RunnerConfigurationSchema
• SchemaRetrieveResponse

Methods:

• client.runners.configurations.schema.retrieve({ ...params }) -> SchemaRetrieveResponse

ScmIntegrations

Types:

• ScmIntegration
• ScmIntegrationOAuthConfig
• ScmIntegrationCreateResponse
• ScmIntegrationRetrieveResponse
• ScmIntegrationUpdateResponse
• ScmIntegrationDeleteResponse

Methods:

• client.runners.configurations.scmIntegrations.create({ ...params }) -> ScmIntegrationCreateResponse
• client.runners.configurations.scmIntegrations.retrieve({ ...params }) -> ScmIntegrationRetrieveResponse
• client.runners.configurations.scmIntegrations.update({ ...params }) -> unknown
• client.runners.configurations.scmIntegrations.list({ ...params }) -> ScmIntegrationsIntegrationsPage
• client.runners.configurations.scmIntegrations.delete({ ...params }) -> unknown

Policies

Types:

• RunnerPolicy
• RunnerRole
• PolicyCreateResponse
• PolicyUpdateResponse
• PolicyDeleteResponse

Methods:

• client.runners.policies.create({ ...params }) -> PolicyCreateResponse
• client.runners.policies.update({ ...params }) -> PolicyUpdateResponse
• client.runners.policies.list({ ...params }) -> RunnerPoliciesPoliciesPage
• client.runners.policies.delete({ ...params }) -> unknown

Secrets

Types:

• Secret
• SecretCreateResponse
• SecretDeleteResponse
• SecretGetValueResponse
• SecretUpdateValueResponse

Methods:

• client.secrets.create({ ...params }) -> SecretCreateResponse
• client.secrets.list({ ...params }) -> SecretsSecretsPage
• client.secrets.delete({ ...params }) -> unknown
• client.secrets.getValue({ ...params }) -> SecretGetValueResponse
• client.secrets.updateValue({ ...params }) -> unknown

Users

Types:

• User
• UserGetAuthenticatedUserResponse
• UserSetSuspendedResponse

Methods:

• client.users.getAuthenticatedUser({ ...params }) -> UserGetAuthenticatedUserResponse
• client.users.setSuspended({ ...params }) -> unknown

Pats

Types:

• PersonalAccessToken
• PatDeleteResponse
• PatGetResponse

Methods:

• client.users.pats.list({ ...params }) -> PersonalAccessTokensPersonalAccessTokensPage
• client.users.pats.delete({ ...params }) -> unknown
• client.users.pats.get({ ...params }) -> PatGetResponse