api.md

Shared Types

from gitpod.types import (
    AutomationTrigger,
    CodexOpenAIModel,
    CodexReasoningEffort,
    CodexServiceTier,
    CodexSettings,
    CountResponseRelation,
    DateRange,
    EnvironmentClass,
    EnvironmentVariableItem,
    EnvironmentVariableSource,
    ErrorCode,
    FieldValue,
    Gateway,
    KernelControlsAction,
    OrganizationRole,
    OrganizationTier,
    Principal,
    ProjectEnvironmentClass,
    ResourceRole,
    ResourceType,
    RunsOn,
    SecretRef,
    Sort,
    SortOrder,
    State,
    Subject,
    Task,
    TaskExecution,
    TaskExecutionMetadata,
    TaskExecutionPhase,
    TaskExecutionSpec,
    TaskExecutionStatus,
    TaskMetadata,
    TaskSpec,
    UserStatus,
)

Accounts

Types:

from gitpod.types import (
    Account,
    AccountMembership,
    JoinableOrganization,
    LoginProvider,
    AccountRetrieveResponse,
    AccountGetSSOLoginURLResponse,
    AccountListSSOLoginsResponse,
)

Methods:

• client.accounts.retrieve(**params) -> AccountRetrieveResponse
• client.accounts.delete(**params) -> object
• client.accounts.get_sso_login_url(**params) -> AccountGetSSOLoginURLResponse
• client.accounts.list_joinable_organizations(**params) -> SyncJoinableOrganizationsPage[JoinableOrganization]
• client.accounts.list_login_providers(**params) -> SyncLoginProvidersPage[LoginProvider]
• client.accounts.list_sso_logins(**params) -> SyncLoginsPage[AccountListSSOLoginsResponse]

Agents

Types:

from gitpod.types import (
    AgentCodeContext,
    AgentExecution,
    AgentMessage,
    AgentMode,
    GoalStatus,
    CodexOpenAIModel,
    CodexReasoningEffort,
    CodexServiceTier,
    CodexSettings,
    Prompt,
    PromptMetadata,
    PromptSpec,
    Role,
    Type,
    UserInputBlock,
    UserInputMetadata,
    WakeEvent,
    AgentCreateExecutionConversationTokenResponse,
    AgentCreatePromptResponse,
    AgentRetrieveExecutionResponse,
    AgentRetrievePromptResponse,
    AgentStartExecutionResponse,
    AgentUpdatePromptResponse,
)

Methods:

• client.agents.create_execution_conversation_token(**params) -> AgentCreateExecutionConversationTokenResponse
• client.agents.create_prompt(**params) -> AgentCreatePromptResponse
• client.agents.delete_execution(**params) -> object
• client.agents.delete_prompt(**params) -> object
• client.agents.list_executions(**params) -> SyncAgentExecutionsPage[AgentExecution]
• client.agents.list_prompts(**params) -> SyncPromptsPage[Prompt]
• client.agents.retrieve_execution(**params) -> AgentRetrieveExecutionResponse
• client.agents.retrieve_prompt(**params) -> AgentRetrievePromptResponse
• client.agents.send_to_execution(**params) -> object
• client.agents.start_execution(**params) -> AgentStartExecutionResponse
• client.agents.stop_execution(**params) -> object
• client.agents.update_prompt(**params) -> AgentUpdatePromptResponse

Automations

Types:

from gitpod.types import (
    Workflow,
    WorkflowAction,
    WorkflowExecution,
    WorkflowExecutionAction,
    WorkflowStep,
    WorkflowTrigger,
    WorkflowTriggerContext,
    AutomationCreateResponse,
    AutomationRetrieveResponse,
    AutomationUpdateResponse,
    AutomationListExecutionOutputsResponse,
    AutomationRetrieveExecutionResponse,
    AutomationRetrieveExecutionActionResponse,
    AutomationStartExecutionResponse,
)

Methods:

• client.automations.create(**params) -> AutomationCreateResponse
• client.automations.retrieve(**params) -> AutomationRetrieveResponse
• client.automations.update(**params) -> AutomationUpdateResponse
• client.automations.list(**params) -> SyncWorkflowsPage[Workflow]
• client.automations.delete(**params) -> object
• client.automations.cancel_execution(**params) -> object
• client.automations.cancel_execution_action(**params) -> object
• client.automations.list_execution_actions(**params) -> SyncWorkflowExecutionActionsPage[WorkflowExecutionAction]
• client.automations.list_execution_outputs(**params) -> SyncOutputsPage[AutomationListExecutionOutputsResponse]
• client.automations.list_executions(**params) -> SyncWorkflowExecutionsPage[WorkflowExecution]
• client.automations.retrieve_execution(**params) -> AutomationRetrieveExecutionResponse
• client.automations.retrieve_execution_action(**params) -> AutomationRetrieveExecutionActionResponse
• client.automations.start_execution(**params) -> AutomationStartExecutionResponse

Billing

Types:

from gitpod.types import (
    AgentExecutionCreditUsage,
    BillingCurrency,
    ByokRateCardTokenType,
    CreditUsageExportGroupBy,
    CreditUsageReportFilter,
    CreditsByType,
    CumulativeCreditUsage,
    DailyCreditUsage,
    DailyEnterpriseAIUsage,
    EnterpriseAITokenUsage,
    EnterpriseAIUsage,
    EnterpriseAIUsageBudget,
    EnterpriseAIUsageBudgetSource,
    EnterpriseAIUsageByModel,
    EnterpriseAIUsageByTokenType,
    EnterpriseAIUsageTimeSeriesFilter,
    EnterpriseAIUserBudgetPolicySource,
    EnvironmentCreditUsage,
    TeamCreditUsage,
    TeamCumulativeCreditUsage,
    TeamEnterpriseAIUsage,
    UsageType,
    UserCostBudgetUsage,
    UserCreditBudgetUsage,
    UserCreditUsage,
    UserEnterpriseAIUsage,
    BillingGetCreditUsageExportResponse,
    BillingGetCreditUsageReportResponse,
    BillingGetCumulativeCreditUsageResponse,
    BillingGetEnterpriseAIUsageSummaryResponse,
    BillingGetEnterpriseAIUsageTimeSeriesResponse,
)

Methods:

• client.billing.get_credit_usage_export(**params) -> BillingGetCreditUsageExportResponse
• client.billing.get_credit_usage_report(**params) -> BillingGetCreditUsageReportResponse
• client.billing.get_cumulative_credit_usage(**params) -> BillingGetCumulativeCreditUsageResponse
• client.billing.get_enterprise_ai_usage_summary(**params) -> BillingGetEnterpriseAIUsageSummaryResponse
• client.billing.get_enterprise_ai_usage_time_series(**params) -> BillingGetEnterpriseAIUsageTimeSeriesResponse
• client.billing.list_enterprise_ai_team_usage(**params) -> SyncTeamUsagePage[TeamEnterpriseAIUsage]
• client.billing.list_enterprise_ai_user_usage(**params) -> SyncUserUsagePage[UserCostBudgetUsage]
• client.billing.list_enterprise_user_credit_usage(**params) -> SyncUserUsagePage[UserCreditBudgetUsage]

Editors

Types:

from gitpod.types import Editor, EditorVersion, EditorRetrieveResponse, EditorResolveURLResponse

Methods:

• client.editors.retrieve(**params) -> EditorRetrieveResponse
• client.editors.list(**params) -> SyncEditorsPage[Editor]
• client.editors.resolve_url(**params) -> EditorResolveURLResponse

Environments

Types:

from gitpod.types import (
    AdmissionLevel,
    BpfDebugLevel,
    Environment,
    EnvironmentActivitySignal,
    EnvironmentMetadata,
    EnvironmentPhase,
    EnvironmentRole,
    EnvironmentSpec,
    EnvironmentStatus,
    KernelControlsConfig,
    Veto,
    EnvironmentCreateResponse,
    EnvironmentRetrieveResponse,
    EnvironmentCreateEnvironmentTokenResponse,
    EnvironmentCreateFromProjectResponse,
    EnvironmentCreateLogsTokenResponse,
)

Methods:

• client.environments.create(**params) -> EnvironmentCreateResponse
• client.environments.retrieve(**params) -> EnvironmentRetrieveResponse
• client.environments.update(**params) -> object
• client.environments.list(**params) -> SyncEnvironmentsPage[Environment]
• client.environments.delete(**params) -> object
• client.environments.create_environment_token(**params) -> EnvironmentCreateEnvironmentTokenResponse
• client.environments.create_from_project(**params) -> EnvironmentCreateFromProjectResponse
• client.environments.create_logs_token(**params) -> EnvironmentCreateLogsTokenResponse
• client.environments.mark_active(**params) -> object
• client.environments.start(**params) -> object
• client.environments.stop(**params) -> object
• client.environments.unarchive(**params) -> object

Automations

Types:

from gitpod.types.environments import AutomationsFile, AutomationUpsertResponse

Methods:

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

Services

Types:

from gitpod.types.environments.automations import (
    Service,
    ServiceMetadata,
    ServicePhase,
    ServiceRole,
    ServiceSpec,
    ServiceStatus,
    ServiceCreateResponse,
    ServiceRetrieveResponse,
)

Methods:

• client.environments.automations.services.create(**params) -> ServiceCreateResponse
• client.environments.automations.services.retrieve(**params) -> ServiceRetrieveResponse
• client.environments.automations.services.update(**params) -> object
• client.environments.automations.services.list(**params) -> SyncServicesPage[Service]
• client.environments.automations.services.delete(**params) -> object
• client.environments.automations.services.start(**params) -> object
• client.environments.automations.services.stop(**params) -> object

Tasks

Types:

from gitpod.types.environments.automations import (
    TaskCreateResponse,
    TaskRetrieveResponse,
    TaskStartResponse,
)

Methods:

• client.environments.automations.tasks.create(**params) -> TaskCreateResponse
• client.environments.automations.tasks.retrieve(**params) -> TaskRetrieveResponse
• client.environments.automations.tasks.update(**params) -> object
• client.environments.automations.tasks.list(**params) -> SyncTasksPage[Task]
• client.environments.automations.tasks.delete(**params) -> object
• client.environments.automations.tasks.start(**params) -> TaskStartResponse

Executions

Types:

from gitpod.types.environments.automations.tasks import ExecutionRetrieveResponse

Methods:

• client.environments.automations.tasks.executions.retrieve(**params) -> ExecutionRetrieveResponse
• client.environments.automations.tasks.executions.list(**params) -> SyncTaskExecutionsPage[TaskExecution]
• client.environments.automations.tasks.executions.stop(**params) -> object

Classes

Methods:

• client.environments.classes.list(**params) -> SyncEnvironmentClassesPage[EnvironmentClass]

Events

Types:

from gitpod.types import (
    AuditLogEntryDetails,
    Process,
    ResourceOperation,
    EventRetrieveResponse,
    EventListResponse,
    EventWatchResponse,
)

Methods:

• client.events.retrieve(**params) -> EventRetrieveResponse
• client.events.list(**params) -> SyncEntriesPage[EventListResponse]
• client.events.watch(**params) -> JSONLDecoder[EventWatchResponse]

Gateways

Methods:

• client.gateways.list(**params) -> SyncGatewaysPage[Gateway]

Groups

Types:

from gitpod.types import Group, GroupCreateResponse, GroupRetrieveResponse, GroupUpdateResponse

Methods:

• client.groups.create(**params) -> GroupCreateResponse
• client.groups.retrieve(**params) -> GroupRetrieveResponse
• client.groups.update(**params) -> GroupUpdateResponse
• client.groups.list(**params) -> SyncGroupsPage[Group]
• client.groups.delete(**params) -> object

Memberships

Types:

from gitpod.types.groups import (
    GroupMembership,
    MembershipCreateResponse,
    MembershipRetrieveResponse,
)

Methods:

• client.groups.memberships.create(**params) -> MembershipCreateResponse
• client.groups.memberships.retrieve(**params) -> MembershipRetrieveResponse
• client.groups.memberships.list(**params) -> SyncMembersPage[GroupMembership]
• client.groups.memberships.delete(**params) -> object

RoleAssignments

Types:

from gitpod.types.groups import RoleAssignment, RoleAssignmentCreateResponse

Methods:

• client.groups.role_assignments.create(**params) -> RoleAssignmentCreateResponse
• client.groups.role_assignments.list(**params) -> SyncAssignmentsPage[RoleAssignment]
• client.groups.role_assignments.delete(**params) -> object

Shares

Methods:

• client.groups.shares.create(**params) -> object
• client.groups.shares.delete(**params) -> object

Identity

Types:

from gitpod.types import (
    IDTokenVersion,
    IdentityExchangeTokenResponse,
    IdentityGetAuthenticatedIdentityResponse,
    IdentityGetIDTokenResponse,
)

Methods:

• client.identity.exchange_token(**params) -> IdentityExchangeTokenResponse
• client.identity.get_authenticated_identity(**params) -> IdentityGetAuthenticatedIdentityResponse
• client.identity.get_id_token(**params) -> IdentityGetIDTokenResponse

Organizations

Types:

from gitpod.types import (
    InviteDomains,
    Organization,
    OrganizationMember,
    OrganizationCreateResponse,
    OrganizationRetrieveResponse,
    OrganizationUpdateResponse,
    OrganizationJoinResponse,
)

Methods:

• client.organizations.create(**params) -> OrganizationCreateResponse
• client.organizations.retrieve(**params) -> OrganizationRetrieveResponse
• client.organizations.update(**params) -> OrganizationUpdateResponse
• client.organizations.delete(**params) -> object
• client.organizations.join(**params) -> OrganizationJoinResponse
• client.organizations.leave(**params) -> object
• client.organizations.list_members(**params) -> SyncMembersPage[OrganizationMember]
• client.organizations.set_role(**params) -> object

AnnouncementBanner

Types:

from gitpod.types.organizations import (
    AnnouncementBanner,
    AnnouncementBannerUpdateResponse,
    AnnouncementBannerGetResponse,
)

Methods:

• client.organizations.announcement_banner.update(**params) -> AnnouncementBannerUpdateResponse
• client.organizations.announcement_banner.get(**params) -> AnnouncementBannerGetResponse

CustomDomains

Types:

from gitpod.types.organizations import (
    CustomDomain,
    CustomDomainProvider,
    CustomDomainCreateResponse,
    CustomDomainRetrieveResponse,
    CustomDomainUpdateResponse,
)

Methods:

• client.organizations.custom_domains.create(**params) -> CustomDomainCreateResponse
• client.organizations.custom_domains.retrieve(**params) -> CustomDomainRetrieveResponse
• client.organizations.custom_domains.update(**params) -> CustomDomainUpdateResponse
• client.organizations.custom_domains.delete(**params) -> object

DomainVerifications

Types:

from gitpod.types.organizations import (
    DomainVerification,
    DomainVerificationState,
    DomainVerificationCreateResponse,
    DomainVerificationRetrieveResponse,
    DomainVerificationVerifyResponse,
)

Methods:

• client.organizations.domain_verifications.create(**params) -> DomainVerificationCreateResponse
• client.organizations.domain_verifications.retrieve(**params) -> DomainVerificationRetrieveResponse
• client.organizations.domain_verifications.list(**params) -> SyncDomainVerificationsPage[DomainVerification]
• client.organizations.domain_verifications.delete(**params) -> object
• client.organizations.domain_verifications.verify(**params) -> DomainVerificationVerifyResponse

Invites

Types:

from gitpod.types.organizations import (
    OrganizationInvite,
    InviteCreateResponse,
    InviteRetrieveResponse,
    InviteGetSummaryResponse,
)

Methods:

• client.organizations.invites.create(**params) -> InviteCreateResponse
• client.organizations.invites.retrieve(**params) -> InviteRetrieveResponse
• client.organizations.invites.get_summary(**params) -> InviteGetSummaryResponse

Policies

Types:

from gitpod.types.organizations import (
    AgentPolicy,
    CodexModelPolicy,
    ConversationSharingPolicy,
    CrowdStrikeConfig,
    CustomAgentEnvMapping,
    CustomSecurityAgent,
    OrganizationPolicies,
    SecurityAgentPolicy,
    VetoExecPolicy,
    PolicyRetrieveResponse,
)

Methods:

• client.organizations.policies.retrieve(**params) -> PolicyRetrieveResponse
• client.organizations.policies.update(**params) -> object

ScimConfigurations

Types:

from gitpod.types.organizations import (
    ScimConfiguration,
    ScimConfigurationCreateResponse,
    ScimConfigurationRetrieveResponse,
    ScimConfigurationUpdateResponse,
    ScimConfigurationRegenerateTokenResponse,
)

Methods:

• client.organizations.scim_configurations.create(**params) -> ScimConfigurationCreateResponse
• client.organizations.scim_configurations.retrieve(**params) -> ScimConfigurationRetrieveResponse
• client.organizations.scim_configurations.update(**params) -> ScimConfigurationUpdateResponse
• client.organizations.scim_configurations.list(**params) -> SyncScimConfigurationsPage[ScimConfiguration]
• client.organizations.scim_configurations.delete(**params) -> object
• client.organizations.scim_configurations.regenerate_token(**params) -> ScimConfigurationRegenerateTokenResponse

SSOConfigurations

Types:

from gitpod.types.organizations import (
    AdditionalScopesUpdate,
    ProviderType,
    SSOConfiguration,
    SSOConfigurationState,
    SSOConfigurationCreateResponse,
    SSOConfigurationRetrieveResponse,
)

Methods:

• client.organizations.sso_configurations.create(**params) -> SSOConfigurationCreateResponse
• client.organizations.sso_configurations.retrieve(**params) -> SSOConfigurationRetrieveResponse
• client.organizations.sso_configurations.update(**params) -> object
• client.organizations.sso_configurations.list(**params) -> SyncSSOConfigurationsPage[SSOConfiguration]
• client.organizations.sso_configurations.delete(**params) -> object

Prebuilds

Types:

from gitpod.types import (
    Prebuild,
    PrebuildMetadata,
    PrebuildPhase,
    PrebuildSpec,
    PrebuildStatus,
    PrebuildTrigger,
    WarmPool,
    WarmPoolMetadata,
    WarmPoolPhase,
    WarmPoolSpec,
    WarmPoolStatus,
    PrebuildCreateResponse,
    PrebuildRetrieveResponse,
    PrebuildCancelResponse,
    PrebuildCreateLogsTokenResponse,
    PrebuildCreateWarmPoolResponse,
    PrebuildRetrieveWarmPoolResponse,
    PrebuildUpdateWarmPoolResponse,
)

Methods:

• client.prebuilds.create(**params) -> PrebuildCreateResponse
• client.prebuilds.retrieve(**params) -> PrebuildRetrieveResponse
• client.prebuilds.list(**params) -> SyncPrebuildsPage[Prebuild]
• client.prebuilds.delete(**params) -> object
• client.prebuilds.cancel(**params) -> PrebuildCancelResponse
• client.prebuilds.create_logs_token(**params) -> PrebuildCreateLogsTokenResponse
• client.prebuilds.create_warm_pool(**params) -> PrebuildCreateWarmPoolResponse
• client.prebuilds.delete_warm_pool(**params) -> object
• client.prebuilds.list_warm_pools(**params) -> SyncWarmPoolsPage[WarmPool]
• client.prebuilds.retrieve_warm_pool(**params) -> PrebuildRetrieveWarmPoolResponse
• client.prebuilds.update_warm_pool(**params) -> PrebuildUpdateWarmPoolResponse

Projects

Types:

from gitpod.types import (
    EnvironmentInitializer,
    Project,
    ProjectMetadata,
    ProjectPhase,
    ProjectPrebuildConfiguration,
    RecommendedEditors,
    ProjectCreateResponse,
    ProjectRetrieveResponse,
    ProjectUpdateResponse,
    ProjectBulkCreateResponse,
    ProjectBulkDeleteResponse,
    ProjectBulkUpdateResponse,
    ProjectCreateFromEnvironmentResponse,
)

Methods:

• client.projects.create(**params) -> ProjectCreateResponse
• client.projects.retrieve(**params) -> ProjectRetrieveResponse
• client.projects.update(**params) -> ProjectUpdateResponse
• client.projects.list(**params) -> SyncProjectsPage[Project]
• client.projects.delete(**params) -> object
• client.projects.bulk_create(**params) -> ProjectBulkCreateResponse
• client.projects.bulk_delete(**params) -> ProjectBulkDeleteResponse
• client.projects.bulk_update(**params) -> ProjectBulkUpdateResponse
• client.projects.create_from_environment(**params) -> ProjectCreateFromEnvironmentResponse

EnvironmentClases

Methods:

• client.projects.environment_clases.update(**params) -> object
• client.projects.environment_clases.list(**params) -> SyncProjectEnvironmentClassesPage[ProjectEnvironmentClass]

Policies

Types:

from gitpod.types.projects import (
    ProjectPolicy,
    ProjectRole,
    PolicyCreateResponse,
    PolicyUpdateResponse,
)

Methods:

• client.projects.policies.create(**params) -> PolicyCreateResponse
• client.projects.policies.update(**params) -> PolicyUpdateResponse
• client.projects.policies.list(**params) -> SyncPoliciesPage[ProjectPolicy]
• client.projects.policies.delete(**params) -> object

Runners

Types:

from gitpod.types import (
    GatewayInfo,
    LogLevel,
    MetricsConfiguration,
    Runner,
    RunnerCapability,
    RunnerConfiguration,
    RunnerKind,
    RunnerPhase,
    RunnerProvider,
    RunnerReleaseChannel,
    RunnerSpec,
    RunnerStatus,
    RunnerVariant,
    SearchMode,
    UpdateWindow,
    RunnerCreateResponse,
    RunnerRetrieveResponse,
    RunnerCheckAuthenticationForHostResponse,
    RunnerCheckRepositoryAccessResponse,
    RunnerCreateLogsTokenResponse,
    RunnerCreateRunnerTokenResponse,
    RunnerListScmOrganizationsResponse,
    RunnerParseContextURLResponse,
    RunnerSearchRepositoriesResponse,
)

Methods:

• client.runners.create(**params) -> RunnerCreateResponse
• client.runners.retrieve(**params) -> RunnerRetrieveResponse
• client.runners.update(**params) -> object
• client.runners.list(**params) -> SyncRunnersPage[Runner]
• client.runners.delete(**params) -> object
• client.runners.check_authentication_for_host(**params) -> RunnerCheckAuthenticationForHostResponse
• client.runners.check_repository_access(**params) -> RunnerCheckRepositoryAccessResponse
• client.runners.create_logs_token(**params) -> RunnerCreateLogsTokenResponse
• client.runners.create_runner_token(**params) -> RunnerCreateRunnerTokenResponse
• client.runners.list_scm_organizations(**params) -> SyncOrganizationsPage[RunnerListScmOrganizationsResponse]
• client.runners.parse_context_url(**params) -> RunnerParseContextURLResponse
• client.runners.search_repositories(**params) -> RunnerSearchRepositoriesResponse

Configurations

Types:

from gitpod.types.runners import (
    EnvironmentClassValidationResult,
    FieldValidationError,
    ScmIntegrationValidationResult,
    ConfigurationValidateResponse,
)

Methods:

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

EnvironmentClasses

Types:

from gitpod.types.runners.configurations import (
    EnvironmentClassCreateResponse,
    EnvironmentClassRetrieveResponse,
)

Methods:

• client.runners.configurations.environment_classes.create(**params) -> EnvironmentClassCreateResponse
• client.runners.configurations.environment_classes.retrieve(**params) -> EnvironmentClassRetrieveResponse
• client.runners.configurations.environment_classes.update(**params) -> object
• client.runners.configurations.environment_classes.list(**params) -> SyncEnvironmentClassesPage[EnvironmentClass]

HostAuthenticationTokens

Types:

from gitpod.types.runners.configurations import (
    HostAuthenticationToken,
    HostAuthenticationTokenSource,
    HostAuthenticationTokenCreateResponse,
    HostAuthenticationTokenRetrieveResponse,
)

Methods:

• client.runners.configurations.host_authentication_tokens.create(**params) -> HostAuthenticationTokenCreateResponse
• client.runners.configurations.host_authentication_tokens.retrieve(**params) -> HostAuthenticationTokenRetrieveResponse
• client.runners.configurations.host_authentication_tokens.update(**params) -> object
• client.runners.configurations.host_authentication_tokens.list(**params) -> SyncTokensPage[HostAuthenticationToken]
• client.runners.configurations.host_authentication_tokens.delete(**params) -> object

Schema

Types:

from gitpod.types.runners.configurations import RunnerConfigurationSchema, SchemaRetrieveResponse

Methods:

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

ScmIntegrations

Types:

from gitpod.types.runners.configurations import (
    ScmIntegration,
    ScmIntegrationOAuthConfig,
    ScmIntegrationCreateResponse,
    ScmIntegrationRetrieveResponse,
)

Methods:

• client.runners.configurations.scm_integrations.create(**params) -> ScmIntegrationCreateResponse
• client.runners.configurations.scm_integrations.retrieve(**params) -> ScmIntegrationRetrieveResponse
• client.runners.configurations.scm_integrations.update(**params) -> object
• client.runners.configurations.scm_integrations.list(**params) -> SyncIntegrationsPage[ScmIntegration]
• client.runners.configurations.scm_integrations.delete(**params) -> object

Policies

Types:

from gitpod.types.runners import (
    RunnerPolicy,
    RunnerRole,
    PolicyCreateResponse,
    PolicyUpdateResponse,
)

Methods:

• client.runners.policies.create(**params) -> PolicyCreateResponse
• client.runners.policies.update(**params) -> PolicyUpdateResponse
• client.runners.policies.list(**params) -> SyncPoliciesPage[RunnerPolicy]
• client.runners.policies.delete(**params) -> object

Secrets

Types:

from gitpod.types import Secret, SecretScope, SecretCreateResponse, SecretGetValueResponse

Methods:

• client.secrets.create(**params) -> SecretCreateResponse
• client.secrets.list(**params) -> SyncSecretsPage[Secret]
• client.secrets.delete(**params) -> object
• client.secrets.get_value(**params) -> SecretGetValueResponse
• client.secrets.update_value(**params) -> object

SecurityPolicies

Types:

from gitpod.types import (
    SecurityPolicy,
    SecurityPolicyCreateResponse,
    SecurityPolicyRetrieveResponse,
    SecurityPolicyUpdateResponse,
)

Methods:

• client.security_policies.create(**params) -> SecurityPolicyCreateResponse
• client.security_policies.retrieve(**params) -> SecurityPolicyRetrieveResponse
• client.security_policies.update(**params) -> SecurityPolicyUpdateResponse
• client.security_policies.list(**params) -> SyncSecurityPoliciesPage[SecurityPolicy]
• client.security_policies.delete(**params) -> object

Usage

Types:

from gitpod.types import (
    AgentTraceModelBreakdown,
    AgentTraceSummary,
    AgentTraceTimeBucket,
    CoAuthorSummary,
    CoAuthorTimeBucket,
    CoAuthorTool,
    EnvironmentUsageRecord,
    PrSummary,
    PrTimeBucket,
    Resolution,
    SupportedModel,
    TimeSeriesPoint,
    ToolBreakdown,
    UsageGetAdoptionUsageSummaryResponse,
    UsageGetAgentTraceSummaryResponse,
    UsageGetAgentTraceTimeSeriesResponse,
    UsageGetCoAuthorSummaryResponse,
    UsageGetCoAuthorTimeSeriesResponse,
    UsageGetPrSummaryResponse,
    UsageGetPrTimeSeriesResponse,
)

Methods:

• client.usage.get_adoption_usage_summary(**params) -> UsageGetAdoptionUsageSummaryResponse
• client.usage.get_agent_trace_summary(**params) -> UsageGetAgentTraceSummaryResponse
• client.usage.get_agent_trace_time_series(**params) -> UsageGetAgentTraceTimeSeriesResponse
• client.usage.get_co_author_summary(**params) -> UsageGetCoAuthorSummaryResponse
• client.usage.get_co_author_time_series(**params) -> UsageGetCoAuthorTimeSeriesResponse
• client.usage.get_pr_summary(**params) -> UsageGetPrSummaryResponse
• client.usage.get_pr_time_series(**params) -> UsageGetPrTimeSeriesResponse
• client.usage.list_environment_runtime_records(**params) -> SyncRecordsPage[EnvironmentUsageRecord]

Users

Types:

from gitpod.types import User, UserGetAuthenticatedUserResponse, UserGetUserResponse

Methods:

• client.users.delete_user(**params) -> object
• client.users.get_authenticated_user(**params) -> UserGetAuthenticatedUserResponse
• client.users.get_user(**params) -> UserGetUserResponse
• client.users.set_suspended(**params) -> object

Dotfiles

Types:

from gitpod.types.users import DotfilesConfiguration, DotfileGetResponse

Methods:

• client.users.dotfiles.get(**params) -> DotfileGetResponse
• client.users.dotfiles.set(**params) -> object

Pats

Types:

from gitpod.types.users import PersonalAccessToken, PatGetResponse

Methods:

• client.users.pats.list(**params) -> SyncPersonalAccessTokensPage[PersonalAccessToken]
• client.users.pats.delete(**params) -> object
• client.users.pats.get(**params) -> PatGetResponse