swagger

package

v0.1.0-alpha.2 Latest Latest Go to latest Published: May 31, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/hatchet-dev/hatchet

README ¶

Go API client for swagger

Introduction Welcome to the documentation for Hatchet's API.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to http://localhost:8080

Class	Method	HTTP request	Description
GithubAppsApi	FinishGithubAppOAuth	Get /api/v1/oauth/github_app/callback	Start Github App OAuth
GithubAppsApi	GithubAppWebhook	Post /api/v1/webhooks/github_app	Github App Webhook
GithubAppsApi	InstallGithubApp	Get /api/v1/github_app/install	Install Github App
GithubAppsApi	ListGithubRepoBranches	Get /api/v1/github_app/{github_app_installation_id}/repos/{github_repo_owner}/{github_repo_name}/branches	List Github Branches
GithubAppsApi	ListGithubRepos	Get /api/v1/github_app/{github_app_installation_id}/repos	List Github Repos
GithubAppsApi	StartGithubAppOAuth	Get /api/v1/oauth/github_app	Start Github App OAuth
MetadataApi	GetServerMetadata	Get /api/v1/metadata	Get server metadata
ModulesApi	CreateModule	Post /api/v1/teams/{team_id}/modules	Create Module
ModulesApi	CreateModuleRun	Post /api/v1/teams/{team_id}/modules/{module_id}/runs	Create Module Run
ModulesApi	CreateMonitorResult	Post /api/v1/teams/{team_id}/modules/{module_id}/runs/{module_run_id}/monitor_result	Create Monitor Result
ModulesApi	CreateTerraformPlan	Post /api/v1/teams/{team_id}/modules/{module_id}/runs/{module_run_id}/plan	Create Terraform plan
ModulesApi	CreateTerraformState	Post /api/v1/teams/{team_id}/modules/{module_id}/runs/{module_run_id}/tfstate	Create or Update Terraform State
ModulesApi	DeleteModule	Delete /api/v1/teams/{team_id}/modules/{module_id}	Delete Module
ModulesApi	FinalizeModuleRun	Post /api/v1/teams/{team_id}/modules/{module_id}/runs/{module_run_id}/finalize	Finalize module run
ModulesApi	ForceUnlockModule	Post /api/v1/teams/{team_id}/modules/{module_id}/force_unlock	Unlock Module
ModulesApi	GetCurrentModuleValues	Get /api/v1/teams/{team_id}/modules/{module_id}/values/current	Get Current Module Values
ModulesApi	GetModule	Get /api/v1/teams/{team_id}/modules/{module_id}	Get module
ModulesApi	GetModuleEnvVars	Get /api/v1/teams/{team_id}/modules/{module_id}/env_vars/{module_env_vars_id}	Get Module Env Vars
ModulesApi	GetModuleRun	Get /api/v1/teams/{team_id}/modules/{module_id}/runs/{module_run_id}	Get module run
ModulesApi	GetModuleRunLocalToken	Get /api/v1/teams/{team_id}/modules/{module_id}/runs/{module_run_id}/local_token	Get Module Run Token (Local)
ModulesApi	GetModuleRunLogs	Get /api/v1/teams/{team_id}/modules/{module_id}/runs/{module_run_id}/logs	Get logs
ModulesApi	GetModuleRunPlanSummary	Get /api/v1/teams/{team_id}/modules/{module_id}/runs/{module_run_id}/plan_summary	Get plan summary
ModulesApi	GetModuleTarballURL	Get /api/v1/teams/{team_id}/modules/{module_id}/tarball_url	Get Module Tarball URL
ModulesApi	GetModuleValues	Get /api/v1/teams/{team_id}/modules/{module_id}/values/{module_values_id}	Get Module Values
ModulesApi	GetTerraformState	Get /api/v1/teams/{team_id}/modules/{module_id}/runs/{module_run_id}/tfstate	Create or Update Terraform State
ModulesApi	ListModuleRuns	Get /api/v1/teams/{team_id}/modules/{module_id}/runs	List Module Runs
ModulesApi	ListModules	Get /api/v1/teams/{team_id}/modules	List Modules
ModulesApi	UpdateModule	Post /api/v1/teams/{team_id}/modules/{module_id}	Update Module Run
MonitorsApi	CreateMonitor	Post /api/v1/teams/{team_id}/monitors	Create Monitor
MonitorsApi	DeleteMonitor	Delete /api/v1/teams/{team_id}/monitors/{monitor_id}	Delete Monitor
MonitorsApi	GetMonitor	Get /api/v1/teams/{team_id}/monitors/{monitor_id}	Get Monitor
MonitorsApi	ListMonitorResults	Get /api/v1/teams/{team_id}/monitor_results	List Monitor Results
MonitorsApi	ListMonitors	Get /api/v1/teams/{team_id}/monitors	List Monitors
MonitorsApi	UpdateMonitor	Post /api/v1/teams/{team_id}/monitors/{monitor_id}	Update Monitor
OrganizationsApi	AcceptOrgMemberInvite	Post /api/v1/invites/{org_member_invite_id}/{org_member_invite_tok}	Accept an organization invite.
OrganizationsApi	CreateOrgMemberInvite	Post /api/v1/organizations/{org_id}/members	Create a member invite
OrganizationsApi	CreateOrganization	Post /api/v1/organizations	Create a new organization
OrganizationsApi	DeleteOrg	Delete /api/v1/organizations/{org_id}	Delete organization.
OrganizationsApi	DeleteOrgMember	Delete /api/v1/organizations/{org_id}/members/{org_member_id}	Delete organization member.
OrganizationsApi	GetOrgMember	Get /api/v1/organizations/{org_id}/members/{org_member_id}	Get organization member.
OrganizationsApi	GetOrganization	Get /api/v1/organizations/{org_id}	Get an organization
OrganizationsApi	LeaveOrg	Post /api/v1/organizations/{org_id}/leave	Leave an organization
OrganizationsApi	ListOrgMembers	Get /api/v1/organizations/{org_id}/members	List organization members
OrganizationsApi	UpdateOrgMemberPolicies	Post /api/v1/organizations/{org_id}/members/{org_member_id}/update_policies	Update organization member policies.
OrganizationsApi	UpdateOrgOwner	Post /api/v1/organizations/{org_id}/change_owner	Update organization owner.
OrganizationsApi	UpdateOrganization	Post /api/v1/organizations/{org_id}	Update an organization
TeamsApi	AddTeamMember	Post /api/v1/teams/{team_id}/members	Add team member
TeamsApi	CreateTeam	Post /api/v1/organizations/{org_id}/teams	Create a new team.
TeamsApi	DeleteTeam	Delete /api/v1/teams/{team_id}	Delete team.
TeamsApi	DeleteTeamMember	Delete /api/v1/teams/{team_id}/members/{team_member_id}	Delete team member
TeamsApi	GetNotification	Get /api/v1/teams/{team_id}/notifications/{notification_id}	Get notification
TeamsApi	GithubIncomingWebhook	Post /api/v1/teams/{team_id}/github_incoming/{github_incoming_webhook_id}	Github incoming webhook endpoint
TeamsApi	ListNotifications	Get /api/v1/organizations/{org_id}/notifications	List notifications
TeamsApi	ListTeamMembers	Get /api/v1/teams/{team_id}/members	List team members
TeamsApi	ListTeams	Get /api/v1/organizations/{org_id}/teams	List teams.
TeamsApi	UpdateTeam	Post /api/v1/teams/{team_id}	Update team
UsersApi	CreatePersonalAccessToken	Post /api/v1/users/current/settings/pats	Create a new personal access token
UsersApi	CreateUser	Post /api/v1/users	Create a new user
UsersApi	DeleteCurrentUser	Delete /api/v1/users/current	Delete the current user.
UsersApi	DeletePersonalAccessToken	Delete /api/v1/users/current/settings/pats/{pat_id}	Delete the personal access token.
UsersApi	GetCurrentUser	Get /api/v1/users/current	Retrieve the current user.
UsersApi	GetPersonalAccessToken	Get /api/v1/users/current/settings/pats/{pat_id}	Get a personal access token
UsersApi	ListGithubAppInstallations	Get /api/v1/users/current/github_app/installations	List Github App installations
UsersApi	ListPersonalAccessTokens	Get /api/v1/users/current/settings/pats	List personal access tokens.
UsersApi	ListUserOrganizations	Get /api/v1/users/current/organizations	List user organizations
UsersApi	ListUserTeams	Get /api/v1/users/current/teams	List user teams
UsersApi	LoginUser	Post /api/v1/users/login	Login user
UsersApi	LogoutUser	Post /api/v1/users/logout	Logout user
UsersApi	ResendVerificationEmail	Post /api/v1/users/current/verify_email/resend	Resend verification email.
UsersApi	ResetPasswordEmail	Post /api/v1/users/reset_password_email	Reset password (email)
UsersApi	ResetPasswordEmailFinalize	Post /api/v1/users/reset_password_email/finalize	Reset password
UsersApi	ResetPasswordEmailVerify	Post /api/v1/users/reset_password_email/verify	Verify password reset data
UsersApi	ResetPasswordManual	Post /api/v1/users/current/reset_password_manual	Reset password (manual)
UsersApi	RevokePersonalAccessToken	Post /api/v1/users/current/settings/pats/{pat_id}/revoke	Revoke the personal access token.
UsersApi	UpdateCurrentUser	Post /api/v1/users/current	Update the current user.
UsersApi	VerifyEmail	Post /api/v1/users/current/verify_email/finalize	Verify email

Documentation For Models

Documentation For Authorization

Bearer

Author

support@hatchet.run

Documentation ¶

Overview ¶

* API v1 * * # Introduction Welcome to the documentation for Hatchet's API. * * API version: 1.0.0 * Contact: support@hatchet.run * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AddTeamMemberRequest
type ApiError
type ApiErrorBadRequestExample
type ApiErrorForbiddenExample
type ApiErrorNotSupportedExample
type ApiErrors
type ApiResourceMeta
type ApiServerMetadata
type ApiServerMetadataAuth
type BasicAuth
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type CreateModuleRequest
type CreateModuleRequestGithub
type CreateModuleRequestLocal
type CreateModuleResponse
type CreateModuleRunRequest
type CreateModuleRunResponse
type CreateModuleValuesRequestGithub
type CreateMonitorRequest
type CreateMonitorResponse
type CreateMonitorResultRequest
type CreateOrgMemberInviteRequest
type CreateOrgMemberInviteResponse
type CreateOrganizationRequest
type CreateOrganizationResponse
type CreatePatRequest
type CreatePatResponse
type CreatePersonalAccessTokenRequest
type CreateTeamRequest
type CreateTeamResponse
type CreateTerraformPlanRequest
type CreateTerraformStateRequest
type CreateUserRequest
type CreateUserResponse
type DeleteModuleResponse
type DeleteMonitorResponse
type DeleteOrganizationResponse
type DeletePatResponse
type DeleteTeamResponse
type EmptyResponse
type FinalizeModuleRunRequest
type FinalizeModuleRunResponse
type ForceUnlockModuleResponse
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetLogsResponse
type GetModuleEnvVarsVersionResponse
type GetModuleResponse
type GetModuleRunResponse
type GetModuleRunTokenResponse
type GetModuleTarballUrlRequest
type GetModuleTarballUrlResponse
type GetModuleValuesResponse
type GetMonitorResponse
type GetNotificationResponse
type GetOrgMemberResponse
type GetOrganizationResponse
type GetPatResponse
type GetTerraformPlanResponse
type GetUserResponse
type GithubAppInstallation
type GithubAppsApiService
- func (a *GithubAppsApiService) FinishGithubAppOAuth(ctx context.Context) (*http.Response, error)
- func (a *GithubAppsApiService) GithubAppWebhook(ctx context.Context) (*http.Response, error)
- func (a *GithubAppsApiService) InstallGithubApp(ctx context.Context) (*http.Response, error)
- func (a *GithubAppsApiService) ListGithubRepoBranches(ctx context.Context) ([]GithubBranch, *http.Response, error)
- func (a *GithubAppsApiService) ListGithubRepos(ctx context.Context, githubAppInstallationId string) ([]GithubRepo, *http.Response, error)
- func (a *GithubAppsApiService) StartGithubAppOAuth(ctx context.Context) (*http.Response, error)
type GithubBranch
type GithubPullRequest
type GithubRepo
type ListGithubAppInstallationsResponse
type ListModuleRunsResponse
type ListModulesResponse
type ListMonitorResultsResponse
type ListMonitorsResponse
type ListNotificationsResponse
type ListOrgMembersResponse
type ListPatsResponse
type ListTeamMembersResponse
type ListTeamsResponse
type ListUserOrgsResponse
type ListUserTeamsResponse
type LockTerraformStateRequest
type LockTerraformStateResponse
type LoginUserRequest
type LoginUserResponse
type MetadataApiService
- func (a *MetadataApiService) GetServerMetadata(ctx context.Context) (ApiServerMetadata, *http.Response, error)
type Module
type ModuleDeploymentConfig
type ModuleEnvVar
type ModuleEnvVarsVersion
type ModuleMonitor
type ModuleMonitorMeta
type ModuleMonitorResult
type ModulePlannedChangeSummary
type ModuleRun
type ModuleRunConfig
type ModuleRunOverview
type ModuleValues
type ModuleValuesGithubConfig
type ModulesApiGetCurrentModuleValuesOpts
type ModulesApiGetModuleTarballURLOpts
type ModulesApiListModuleRunsOpts
type ModulesApiListModulesOpts
type ModulesApiService
- func (a *ModulesApiService) CreateModule(ctx context.Context, body CreateModuleRequest, teamId string) (CreateModuleResponse, *http.Response, error)
- func (a *ModulesApiService) CreateModuleRun(ctx context.Context, body CreateModuleRunRequest, teamId string, ...) (CreateModuleRunResponse, *http.Response, error)
- func (a *ModulesApiService) CreateMonitorResult(ctx context.Context, body CreateMonitorResultRequest, teamId string, ...) (*http.Response, error)
- func (a *ModulesApiService) CreateTerraformPlan(ctx context.Context, body CreateTerraformPlanRequest, teamId string, ...) (*http.Response, error)
- func (a *ModulesApiService) CreateTerraformState(ctx context.Context, teamId string, moduleId string, moduleRunId string) (*http.Response, error)
- func (a *ModulesApiService) DeleteModule(ctx context.Context, teamId string, moduleId string) (DeleteModuleResponse, *http.Response, error)
- func (a *ModulesApiService) FinalizeModuleRun(ctx context.Context, body FinalizeModuleRunRequest, teamId string, ...) (FinalizeModuleRunResponse, *http.Response, error)
- func (a *ModulesApiService) ForceUnlockModule(ctx context.Context) (ForceUnlockModuleResponse, *http.Response, error)
- func (a *ModulesApiService) GetCurrentModuleValues(ctx context.Context, teamId string, moduleId string, ...) (map[string]interface{}, *http.Response, error)
- func (a *ModulesApiService) GetModule(ctx context.Context, teamId string, moduleId string) (GetModuleResponse, *http.Response, error)
- func (a *ModulesApiService) GetModuleEnvVars(ctx context.Context, teamId string, moduleId string, moduleEnvVarsId string) (GetModuleEnvVarsVersionResponse, *http.Response, error)
- func (a *ModulesApiService) GetModuleRun(ctx context.Context, teamId string, moduleId string, moduleRunId string) (GetModuleRunResponse, *http.Response, error)
- func (a *ModulesApiService) GetModuleRunLocalToken(ctx context.Context, teamId string, moduleId string, moduleRunId string) (GetModuleRunTokenResponse, *http.Response, error)
- func (a *ModulesApiService) GetModuleRunLogs(ctx context.Context, teamId string, moduleId string, moduleRunId string) (GetLogsResponse, *http.Response, error)
- func (a *ModulesApiService) GetModuleRunPlanSummary(ctx context.Context) ([]ModulePlannedChangeSummary, *http.Response, error)
- func (a *ModulesApiService) GetModuleTarballURL(ctx context.Context, teamId string, moduleId string, ...) (GetModuleTarballUrlResponse, *http.Response, error)
- func (a *ModulesApiService) GetModuleValues(ctx context.Context) (GetModuleValuesResponse, *http.Response, error)
- func (a *ModulesApiService) GetTerraformState(ctx context.Context, teamId string, moduleId string, moduleRunId string) (*http.Response, error)
- func (a *ModulesApiService) ListModuleRuns(ctx context.Context, teamId string, moduleId string, ...) (ListModuleRunsResponse, *http.Response, error)
- func (a *ModulesApiService) ListModules(ctx context.Context, teamId string, ...) (ListModulesResponse, *http.Response, error)
- func (a *ModulesApiService) UpdateModule(ctx context.Context, teamId string, moduleId string, ...) (UpdateModuleResponse, *http.Response, error)
type ModulesApiUpdateModuleOpts
type MonitorsApiCreateMonitorOpts
type MonitorsApiListMonitorResultsOpts
type MonitorsApiListMonitorsOpts
type MonitorsApiService
- func (a *MonitorsApiService) CreateMonitor(ctx context.Context, teamId string, ...) (CreateMonitorResponse, *http.Response, error)
- func (a *MonitorsApiService) DeleteMonitor(ctx context.Context, teamId string, monitorId string) (DeleteMonitorResponse, *http.Response, error)
- func (a *MonitorsApiService) GetMonitor(ctx context.Context, teamId string, monitorId string) (GetMonitorResponse, *http.Response, error)
- func (a *MonitorsApiService) ListMonitorResults(ctx context.Context, localVarOptionals *MonitorsApiListMonitorResultsOpts) (ListMonitorResultsResponse, *http.Response, error)
- func (a *MonitorsApiService) ListMonitors(ctx context.Context, teamId string, ...) (ListMonitorsResponse, *http.Response, error)
- func (a *MonitorsApiService) UpdateMonitor(ctx context.Context, teamId string, monitorId string, ...) (UpdateMonitorResponse, *http.Response, error)
type MonitorsApiUpdateMonitorOpts
type Notification
type NotificationMeta
type Organization
type OrganizationInvite
type OrganizationInviteSanitized
type OrganizationMember
type OrganizationMemberSanitized
type OrganizationPolicyMeta
type OrganizationPolicyReference
type OrganizationsApiCreateOrgMemberInviteOpts
type OrganizationsApiCreateOrganizationOpts
type OrganizationsApiListOrgMembersOpts
type OrganizationsApiService
- func (a *OrganizationsApiService) AcceptOrgMemberInvite(ctx context.Context, orgMemberInviteId string, orgMemberInviteTok string) (EmptyResponse, *http.Response, error)
- func (a *OrganizationsApiService) CreateOrgMemberInvite(ctx context.Context, orgId string, ...) (CreateOrgMemberInviteResponse, *http.Response, error)
- func (a *OrganizationsApiService) CreateOrganization(ctx context.Context, localVarOptionals *OrganizationsApiCreateOrganizationOpts) (CreateOrganizationResponse, *http.Response, error)
- func (a *OrganizationsApiService) DeleteOrg(ctx context.Context) (DeleteOrganizationResponse, *http.Response, error)
- func (a *OrganizationsApiService) DeleteOrgMember(ctx context.Context, orgId string) (EmptyResponse, *http.Response, error)
- func (a *OrganizationsApiService) GetOrgMember(ctx context.Context, orgId string, orgMemberId string) (GetOrgMemberResponse, *http.Response, error)
- func (a *OrganizationsApiService) GetOrganization(ctx context.Context, orgId string) (GetOrganizationResponse, *http.Response, error)
- func (a *OrganizationsApiService) LeaveOrg(ctx context.Context, orgId string) (EmptyResponse, *http.Response, error)
- func (a *OrganizationsApiService) ListOrgMembers(ctx context.Context, localVarOptionals *OrganizationsApiListOrgMembersOpts) (ListOrgMembersResponse, *http.Response, error)
- func (a *OrganizationsApiService) UpdateOrgMemberPolicies(ctx context.Context, orgId string, orgMemberId string) (UpdateOrgMemberPoliciesResponse, *http.Response, error)
- func (a *OrganizationsApiService) UpdateOrgOwner(ctx context.Context, orgId string) (EmptyResponse, *http.Response, error)
- func (a *OrganizationsApiService) UpdateOrganization(ctx context.Context, orgId string, ...) (UpdateOrgResponse, *http.Response, error)
type OrganizationsApiUpdateOrganizationOpts
type PaginationResponse
type PersonalAccessToken
type ResetPasswordEmailFinalizeRequest
type ResetPasswordEmailRequest
type ResetPasswordEmailVerifyRequest
type ResetPasswordEmailVerifyTokenRequest
type ResetPasswordManualRequest
type RevokePatResponse
type RevokePatResponseExample
type Team
type TeamAddMemberRequest
type TeamAddMemberResponse
type TeamMember
type TeamPolicyMeta
type TeamPolicyReference
type TeamUpdateRequest
type TeamUpdateResponse
type TeamsApiAddTeamMemberOpts
type TeamsApiCreateTeamOpts
type TeamsApiListNotificationsOpts
type TeamsApiListTeamMembersOpts
type TeamsApiListTeamsOpts
type TeamsApiService
- func (a *TeamsApiService) AddTeamMember(ctx context.Context, teamId string, ...) (TeamAddMemberResponse, *http.Response, error)
- func (a *TeamsApiService) CreateTeam(ctx context.Context, orgId string, localVarOptionals *TeamsApiCreateTeamOpts) (CreateTeamResponse, *http.Response, error)
- func (a *TeamsApiService) DeleteTeam(ctx context.Context, teamId string) (DeleteTeamResponse, *http.Response, error)
- func (a *TeamsApiService) DeleteTeamMember(ctx context.Context, teamId string) (EmptyResponse, *http.Response, error)
- func (a *TeamsApiService) GetNotification(ctx context.Context, teamId string) (GetNotificationResponse, *http.Response, error)
- func (a *TeamsApiService) GithubIncomingWebhook(ctx context.Context, teamId string, githubIncomingWebhookId string) (*http.Response, error)
- func (a *TeamsApiService) ListNotifications(ctx context.Context, localVarOptionals *TeamsApiListNotificationsOpts) (ListNotificationsResponse, *http.Response, error)
- func (a *TeamsApiService) ListTeamMembers(ctx context.Context, localVarOptionals *TeamsApiListTeamMembersOpts) (ListTeamMembersResponse, *http.Response, error)
- func (a *TeamsApiService) ListTeams(ctx context.Context, localVarOptionals *TeamsApiListTeamsOpts) (ListTeamsResponse, *http.Response, error)
- func (a *TeamsApiService) UpdateTeam(ctx context.Context, teamId string, localVarOptionals *TeamsApiUpdateTeamOpts) (TeamUpdateResponse, *http.Response, error)
type TeamsApiUpdateTeamOpts
type TerraformLock
type TestsApiService
- func (a *TestsApiService) GetModuleTarballURL(ctx context.Context, teamId string, moduleId string) (GetModuleTarballUrlResponse, *http.Response, error)
type UpdateModuleRequest
type UpdateModuleResponse
type UpdateMonitorRequest
type UpdateMonitorResponse
type UpdateOrgMemberPoliciesRequest
type UpdateOrgMemberPoliciesResponse
type UpdateOrgOwnerRequest
type UpdateOrgRequest
type UpdateOrgResponse
type UpdateOrganizationRequest
type UpdateUserRequest
type UpdateUserResponse
type User
type UserOrgPublishedData
type UsersApiCreatePersonalAccessTokenOpts
type UsersApiCreateUserOpts
type UsersApiListGithubAppInstallationsOpts
type UsersApiListPersonalAccessTokensOpts
type UsersApiListUserOrganizationsOpts
type UsersApiListUserTeamsOpts
type UsersApiLoginUserOpts
type UsersApiResetPasswordEmailFinalizeOpts
type UsersApiResetPasswordEmailOpts
type UsersApiResetPasswordEmailVerifyOpts
type UsersApiResetPasswordManualOpts
type UsersApiService
- func (a *UsersApiService) CreatePersonalAccessToken(ctx context.Context, localVarOptionals *UsersApiCreatePersonalAccessTokenOpts) (CreatePatResponse, *http.Response, error)
- func (a *UsersApiService) CreateUser(ctx context.Context, localVarOptionals *UsersApiCreateUserOpts) (CreateUserResponse, *http.Response, error)
- func (a *UsersApiService) DeleteCurrentUser(ctx context.Context) (EmptyResponse, *http.Response, error)
- func (a *UsersApiService) DeletePersonalAccessToken(ctx context.Context, patId string) (DeletePatResponse, *http.Response, error)
- func (a *UsersApiService) GetCurrentUser(ctx context.Context) (GetUserResponse, *http.Response, error)
- func (a *UsersApiService) GetPersonalAccessToken(ctx context.Context, patId string) (GetPatResponse, *http.Response, error)
- func (a *UsersApiService) ListGithubAppInstallations(ctx context.Context, localVarOptionals *UsersApiListGithubAppInstallationsOpts) (ListGithubAppInstallationsResponse, *http.Response, error)
- func (a *UsersApiService) ListPersonalAccessTokens(ctx context.Context, localVarOptionals *UsersApiListPersonalAccessTokensOpts) (ListPatsResponse, *http.Response, error)
- func (a *UsersApiService) ListUserOrganizations(ctx context.Context, localVarOptionals *UsersApiListUserOrganizationsOpts) (ListUserOrgsResponse, *http.Response, error)
- func (a *UsersApiService) ListUserTeams(ctx context.Context, localVarOptionals *UsersApiListUserTeamsOpts) (ListUserTeamsResponse, *http.Response, error)
- func (a *UsersApiService) LoginUser(ctx context.Context, localVarOptionals *UsersApiLoginUserOpts) (LoginUserResponse, *http.Response, error)
- func (a *UsersApiService) LogoutUser(ctx context.Context) (EmptyResponse, *http.Response, error)
- func (a *UsersApiService) ResendVerificationEmail(ctx context.Context) (EmptyResponse, *http.Response, error)
- func (a *UsersApiService) ResetPasswordEmail(ctx context.Context, localVarOptionals *UsersApiResetPasswordEmailOpts) (EmptyResponse, *http.Response, error)
- func (a *UsersApiService) ResetPasswordEmailFinalize(ctx context.Context, localVarOptionals *UsersApiResetPasswordEmailFinalizeOpts) (EmptyResponse, *http.Response, error)
- func (a *UsersApiService) ResetPasswordEmailVerify(ctx context.Context, localVarOptionals *UsersApiResetPasswordEmailVerifyOpts) (EmptyResponse, *http.Response, error)
- func (a *UsersApiService) ResetPasswordManual(ctx context.Context, localVarOptionals *UsersApiResetPasswordManualOpts) (EmptyResponse, *http.Response, error)
- func (a *UsersApiService) RevokePersonalAccessToken(ctx context.Context, patId string) (RevokePatResponseExample, *http.Response, error)
- func (a *UsersApiService) UpdateCurrentUser(ctx context.Context, localVarOptionals *UsersApiUpdateCurrentUserOpts) (UpdateUserResponse, *http.Response, error)
- func (a *UsersApiService) VerifyEmail(ctx context.Context, localVarOptionals *UsersApiVerifyEmailOpts) (EmptyResponse, *http.Response, error)
type UsersApiUpdateCurrentUserOpts
type UsersApiVerifyEmailOpts
type VerifyEmailRequest

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	GithubAppsApi *GithubAppsApiService

	MetadataApi *MetadataApiService

	ModulesApi *ModulesApiService

	MonitorsApi *MonitorsApiService

	OrganizationsApi *OrganizationsApiService

	TeamsApi *TeamsApiService

	UsersApi *UsersApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the API v1 API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AddTeamMemberRequest ¶

type AddTeamMemberRequest struct {
	// the organization member id of the new team member
	OrgMemberId string `json:"org_member_id,omitempty"`
	// the set of policies for this user
	Policies []TeamPolicyReference `json:"policies"`
}

type ApiError ¶

type ApiError struct {
	// a custom Hatchet error code
	Code int32 `json:"code,omitempty"`
	// a description for this error
	Description string `json:"description,omitempty"`
	// a link to the documentation for this error, if it exists
	DocsLink string `json:"docs_link,omitempty"`
}

type ApiErrorBadRequestExample ¶

type ApiErrorBadRequestExample struct {
	// a custom Hatchet error code
	Code int32 `json:"code,omitempty"`
	// a description for this error
	Description string `json:"description,omitempty"`
	// a link to the documentation for this error, if it exists
	DocsLink string `json:"docs_link,omitempty"`
}

type ApiErrorForbiddenExample ¶

type ApiErrorForbiddenExample struct {
	// a custom Hatchet error code
	Code int32 `json:"code,omitempty"`
	// a description for this error
	Description string `json:"description,omitempty"`
	// a link to the documentation for this error, if it exists
	DocsLink string `json:"docs_link,omitempty"`
}

type ApiErrorNotSupportedExample ¶

type ApiErrorNotSupportedExample struct {
	// a custom Hatchet error code
	Code int32 `json:"code,omitempty"`
	// a description for this error
	Description string `json:"description,omitempty"`
	// a link to the documentation for this error, if it exists
	DocsLink string `json:"docs_link,omitempty"`
}

type ApiErrors ¶

type ApiErrors struct {
	Errors []ApiError `json:"errors,omitempty"`
}

type ApiResourceMeta ¶

type ApiResourceMeta struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id string `json:"id,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type ApiServerMetadata ¶

type ApiServerMetadata struct {
	Auth *ApiServerMetadataAuth `json:"auth,omitempty"`
}

type ApiServerMetadataAuth ¶

type ApiServerMetadataAuth struct {
	// whether email verification is required in order to use the api/dashboard
	RequireEmailVerification bool `json:"require_email_verification,omitempty"`
}

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateModuleRequest ¶

type CreateModuleRequest struct {
	EnvVars      map[string]string                `json:"env_vars,omitempty"`
	Github       *CreateModuleRequestGithub       `json:"github,omitempty"`
	Local        *CreateModuleRequestLocal        `json:"local,omitempty"`
	Name         string                           `json:"name,omitempty"`
	ValuesGithub *CreateModuleValuesRequestGithub `json:"values_github,omitempty"`
	ValuesRaw    map[string]interface{}           `json:"values_raw,omitempty"`
}

type CreateModuleRequestGithub ¶

type CreateModuleRequestGithub struct {
	// this refers to the Hatchet app installation id, **not** the installation id stored on Github
	GithubAppInstallationId string `json:"github_app_installation_id"`
	// the repository branch on Github
	GithubRepositoryBranch string `json:"github_repository_branch"`
	// the repository name on Github
	GithubRepositoryName string `json:"github_repository_name"`
	// the repository owner on Github
	GithubRepositoryOwner string `json:"github_repository_owner"`
	// path to the module in the github repository
	Path string `json:"path"`
}

type CreateModuleRequestLocal ¶

type CreateModuleRequestLocal struct {
	// the local path to the module
	LocalPath string `json:"local_path,omitempty"`
}

type CreateModuleResponse ¶

type CreateModuleResponse struct {
	// the time that this resource was created
	CreatedAt               time.Time               `json:"created_at,omitempty"`
	CurrentEnvVarsVersionId string                  `json:"current_env_vars_version_id,omitempty"`
	CurrentValuesVersionId  string                  `json:"current_values_version_id,omitempty"`
	Deployment              *ModuleDeploymentConfig `json:"deployment,omitempty"`
	// the id of this resource, in UUID format
	Id       string `json:"id,omitempty"`
	LockId   string `json:"lock_id,omitempty"`
	LockKind string `json:"lock_kind,omitempty"`
	// the name for the module
	Name string `json:"name,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type CreateModuleRunRequest ¶

type CreateModuleRunRequest struct {
	Hostname string `json:"hostname,omitempty"`
	Kind     string `json:"kind,omitempty"`
}

type CreateModuleRunResponse ¶

type CreateModuleRunResponse struct {
	Config *ModuleRunConfig `json:"config,omitempty"`
	// the time that this resource was created
	CreatedAt         time.Time          `json:"created_at,omitempty"`
	GithubPullRequest *GithubPullRequest `json:"github_pull_request,omitempty"`
	// the id of this resource, in UUID format
	Id                string                `json:"id,omitempty"`
	Kind              string                `json:"kind,omitempty"`
	MonitorResults    []ModuleMonitorResult `json:"monitor_results,omitempty"`
	Monitors          []ModuleMonitor       `json:"monitors,omitempty"`
	Status            string                `json:"status,omitempty"`
	StatusDescription string                `json:"status_description,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type CreateModuleValuesRequestGithub ¶

type CreateModuleValuesRequestGithub struct {
	// this refers to the Hatchet app installation id, **not** the installation id stored on Github
	GithubAppInstallationId string `json:"github_app_installation_id"`
	// the repository branch on Github
	GithubRepositoryBranch string `json:"github_repository_branch"`
	// the repository name on Github
	GithubRepositoryName string `json:"github_repository_name"`
	// the repository owner on Github
	GithubRepositoryOwner string `json:"github_repository_owner"`
	// path to the module values in the github repository (including file name)
	Path string `json:"path"`
}

type CreateMonitorRequest ¶

type CreateMonitorRequest struct {
	CronSchedule string `json:"cron_schedule,omitempty"`
	Description  string `json:"description,omitempty"`
	// Whether the monitor is disabled. In order to turn the monitor off for all modules, set disabled=true. Passing in an empty module list will trigger this monitor for all modules.
	Disabled bool   `json:"disabled,omitempty"`
	Kind     string `json:"kind,omitempty"`
	// A list of module ids. If empty or omitted, this monitor targets all modules.
	Modules     []string `json:"modules,omitempty"`
	Name        string   `json:"name,omitempty"`
	PolicyBytes string   `json:"policy_bytes,omitempty"`
}

type CreateMonitorResponse ¶

type CreateMonitorResponse struct {
}

type CreateMonitorResultRequest ¶

type CreateMonitorResultRequest struct {
	FailureMessages []string `json:"failure_messages,omitempty"`
	MonitorId       string   `json:"monitor_id,omitempty"`
	Severity        string   `json:"severity,omitempty"`
	Status          string   `json:"status,omitempty"`
	SuccessMessage  string   `json:"success_message,omitempty"`
	Title           string   `json:"title,omitempty"`
}

type CreateOrgMemberInviteRequest ¶

type CreateOrgMemberInviteRequest struct {
	// the email address to use for the invite
	InviteeEmail string `json:"invitee_email"`
	// the set of policies for this user
	InviteePolicies []OrganizationPolicyReference `json:"invitee_policies"`
}

type CreateOrgMemberInviteResponse ¶

type CreateOrgMemberInviteResponse struct {
}

type CreateOrganizationRequest ¶

type CreateOrganizationRequest struct {
	// the display name for the organization
	DisplayName string `json:"display_name"`
}

type CreateOrganizationResponse ¶

type CreateOrganizationResponse struct {
}

type CreatePatRequest ¶

type CreatePatRequest struct {
	// the display name for the personal access token
	DisplayName string `json:"display_name"`
}

type CreatePatResponse ¶

type CreatePatResponse struct {
	Pat *PersonalAccessToken `json:"pat,omitempty"`
	// the raw JWT token. see API documentation for details
	Token string `json:"token,omitempty"`
}

type CreatePersonalAccessTokenRequest ¶

type CreatePersonalAccessTokenRequest struct {
	// the display name for the personal access token
	DisplayName string `json:"display_name"`
}

type CreateTeamRequest ¶

type CreateTeamRequest struct {
	// the display name for the team
	DisplayName string `json:"display_name"`
}

type CreateTeamResponse ¶

type CreateTeamResponse struct {
}

type CreateTerraformPlanRequest ¶

type CreateTerraformPlanRequest struct {
	// the JSON contents of the plan
	PlanJson string `json:"plan_json"`
	// the prettified contents of the plan
	PlanPretty string `json:"plan_pretty"`
}

type CreateTerraformStateRequest ¶

type CreateTerraformStateRequest struct {
	ID string `json:"ID,omitempty"`
}

type CreateUserRequest ¶

type CreateUserRequest struct {
	// the display name for this user
	DisplayName string `json:"display_name"`
	// the email address for this user
	Email string `json:"email"`
	// the password for this user
	Password string `json:"password"`
}

type CreateUserResponse ¶

type CreateUserResponse struct {
}

type DeleteModuleResponse ¶

type DeleteModuleResponse struct {
}

type DeleteMonitorResponse ¶

type DeleteMonitorResponse struct {
}

type DeleteOrganizationResponse ¶

type DeleteOrganizationResponse struct {
}

type DeletePatResponse ¶

type DeletePatResponse struct {
}

type DeleteTeamResponse ¶

type DeleteTeamResponse struct {
}

type EmptyResponse ¶

type EmptyResponse struct {
}

type FinalizeModuleRunRequest ¶

type FinalizeModuleRunRequest struct {
	// the description for the module run status
	Description string `json:"description"`
	ReportKind  string `json:"report_kind"`
	Status      string `json:"status"`
}

type FinalizeModuleRunResponse ¶

type FinalizeModuleRunResponse struct {
}

type ForceUnlockModuleResponse ¶

type ForceUnlockModuleResponse struct {
}

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetLogsResponse ¶

type GetLogsResponse struct {
	Logs []string `json:"logs,omitempty"`
}

type GetModuleEnvVarsVersionResponse ¶

type GetModuleEnvVarsVersionResponse struct {
}

type GetModuleResponse ¶

type GetModuleResponse struct {
}

type GetModuleRunResponse ¶

type GetModuleRunResponse struct {
}

type GetModuleRunTokenResponse ¶

type GetModuleRunTokenResponse struct {
	Token string `json:"token,omitempty"`
}

type GetModuleTarballUrlRequest ¶

type GetModuleTarballUrlRequest struct {
	// the SHA to get the tarball from
	GithubSha string `json:"github_sha"`
}

type GetModuleTarballUrlResponse ¶

type GetModuleTarballUrlResponse struct {
	Url string `json:"url,omitempty"`
}

type GetModuleValuesResponse ¶

type GetModuleValuesResponse struct {
}

type GetMonitorResponse ¶

type GetMonitorResponse struct {
}

type GetNotificationResponse ¶

type GetNotificationResponse struct {
}

type GetOrgMemberResponse ¶

type GetOrgMemberResponse struct {
}

type GetOrganizationResponse ¶

type GetOrganizationResponse struct {
}

type GetPatResponse ¶

type GetPatResponse struct {
}

type GetTerraformPlanResponse ¶

type GetTerraformPlanResponse struct {
	PlanBytes string `json:"plan_bytes,omitempty"`
}

type GetUserResponse ¶

type GetUserResponse struct {
}

type GithubAppInstallation ¶

type GithubAppInstallation struct {
	AccountAvatarUrl string `json:"account_avatar_url,omitempty"`
	AccountName      string `json:"account_name,omitempty"`
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id                      string `json:"id,omitempty"`
	InstallationId          int64  `json:"installation_id,omitempty"`
	InstallationSettingsUrl string `json:"installation_settings_url,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type GithubAppsApiService ¶

type GithubAppsApiService service

func (*GithubAppsApiService) FinishGithubAppOAuth ¶

func (a *GithubAppsApiService) FinishGithubAppOAuth(ctx context.Context) (*http.Response, error)

GithubAppsApiService Start Github App OAuth Finishes the OAuth flow to authenticate with a Github App.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*GithubAppsApiService) GithubAppWebhook ¶

func (a *GithubAppsApiService) GithubAppWebhook(ctx context.Context) (*http.Response, error)

GithubAppsApiService Github App Webhook Implements a Github App webhook.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*GithubAppsApiService) InstallGithubApp ¶

func (a *GithubAppsApiService) InstallGithubApp(ctx context.Context) (*http.Response, error)

GithubAppsApiService Install Github App Redirects the user to Github to install the Github App.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*GithubAppsApiService) ListGithubRepoBranches ¶

func (a *GithubAppsApiService) ListGithubRepoBranches(ctx context.Context) ([]GithubBranch, *http.Response, error)

GithubAppsApiService List Github Branches Lists the Github repo branches.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []GithubBranch

func (*GithubAppsApiService) ListGithubRepos ¶

func (a *GithubAppsApiService) ListGithubRepos(ctx context.Context, githubAppInstallationId string) ([]GithubRepo, *http.Response, error)

GithubAppsApiService List Github Repos Lists the Github repos that the github app installation has access to.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param githubAppInstallationId The github app installation id

@return []GithubRepo

func (*GithubAppsApiService) StartGithubAppOAuth ¶

func (a *GithubAppsApiService) StartGithubAppOAuth(ctx context.Context) (*http.Response, error)

GithubAppsApiService Start Github App OAuth Starts the OAuth flow to authenticate with a Github App.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

type GithubBranch ¶

type GithubBranch struct {
	BranchName string `json:"branch_name,omitempty"`
	IsDefault  bool   `json:"is_default,omitempty"`
}

type GithubPullRequest ¶

type GithubPullRequest struct {
	GithubPullRequestBaseBranch string `json:"github_pull_request_base_branch,omitempty"`
	GithubPullRequestHeadBranch string `json:"github_pull_request_head_branch,omitempty"`
	GithubPullRequestId         int64  `json:"github_pull_request_id,omitempty"`
	GithubPullRequestNumber     int64  `json:"github_pull_request_number,omitempty"`
	GithubPullRequestState      string `json:"github_pull_request_state,omitempty"`
	GithubPullRequestTitle      string `json:"github_pull_request_title,omitempty"`
	GithubRepositoryName        string `json:"github_repository_name,omitempty"`
	GithubRepositoryOwner       string `json:"github_repository_owner,omitempty"`
}

type GithubRepo ¶

type GithubRepo struct {
	RepoName  string `json:"repo_name,omitempty"`
	RepoOwner string `json:"repo_owner,omitempty"`
}

type ListGithubAppInstallationsResponse ¶

type ListGithubAppInstallationsResponse struct {
	Pagination *PaginationResponse     `json:"pagination,omitempty"`
	Rows       []GithubAppInstallation `json:"rows,omitempty"`
}

type ListModuleRunsResponse ¶

type ListModuleRunsResponse struct {
	Pagination *PaginationResponse `json:"pagination,omitempty"`
	Rows       []ModuleRunOverview `json:"rows,omitempty"`
}

type ListModulesResponse ¶

type ListModulesResponse struct {
	Pagination *PaginationResponse `json:"pagination,omitempty"`
	Rows       []Module            `json:"rows,omitempty"`
}

type ListMonitorResultsResponse ¶

type ListMonitorResultsResponse struct {
	Pagination *PaginationResponse   `json:"pagination,omitempty"`
	Rows       []ModuleMonitorResult `json:"rows,omitempty"`
}

type ListMonitorsResponse ¶

type ListMonitorsResponse struct {
	Pagination *PaginationResponse `json:"pagination,omitempty"`
	Rows       []ModuleMonitorMeta `json:"rows,omitempty"`
}

type ListNotificationsResponse ¶

type ListNotificationsResponse struct {
	Pagination *PaginationResponse `json:"pagination,omitempty"`
	Rows       []NotificationMeta  `json:"rows,omitempty"`
}

type ListOrgMembersResponse ¶

type ListOrgMembersResponse struct {
	Pagination *PaginationResponse           `json:"pagination,omitempty"`
	Rows       []OrganizationMemberSanitized `json:"rows,omitempty"`
}

type ListPatsResponse ¶

type ListPatsResponse struct {
	Pagination *PaginationResponse   `json:"pagination,omitempty"`
	Rows       []PersonalAccessToken `json:"rows,omitempty"`
}

type ListTeamMembersResponse ¶

type ListTeamMembersResponse struct {
	Pagination *PaginationResponse `json:"pagination,omitempty"`
	Rows       []TeamMember        `json:"rows,omitempty"`
}

type ListTeamsResponse ¶

type ListTeamsResponse struct {
	Pagination *PaginationResponse `json:"pagination,omitempty"`
	Rows       []Team              `json:"rows,omitempty"`
}

type ListUserOrgsResponse ¶

type ListUserOrgsResponse struct {
	Pagination *PaginationResponse `json:"pagination,omitempty"`
	Rows       []Organization      `json:"rows,omitempty"`
}

type ListUserTeamsResponse ¶

type ListUserTeamsResponse struct {
	Pagination *PaginationResponse `json:"pagination,omitempty"`
	Rows       []Team              `json:"rows,omitempty"`
}

type LockTerraformStateRequest ¶

type LockTerraformStateRequest struct {
	Created   string `json:"Created,omitempty"`
	ID        string `json:"ID,omitempty"`
	Info      string `json:"Info,omitempty"`
	Operation string `json:"Operation,omitempty"`
	Path      string `json:"Path,omitempty"`
	Version   string `json:"Version,omitempty"`
	Who       string `json:"Who,omitempty"`
}

type LockTerraformStateResponse ¶

type LockTerraformStateResponse struct {
	Created   string `json:"Created,omitempty"`
	ID        string `json:"ID,omitempty"`
	Info      string `json:"Info,omitempty"`
	Operation string `json:"Operation,omitempty"`
	Path      string `json:"Path,omitempty"`
	Version   string `json:"Version,omitempty"`
	Who       string `json:"Who,omitempty"`
}

type LoginUserRequest ¶

type LoginUserRequest struct {
	// the email address for this user
	Email string `json:"email"`
	// the password for this user
	Password string `json:"password"`
}

type LoginUserResponse ¶

type LoginUserResponse struct {
}

type MetadataApiService ¶

type MetadataApiService service

func (*MetadataApiService) GetServerMetadata ¶

func (a *MetadataApiService) GetServerMetadata(ctx context.Context) (ApiServerMetadata, *http.Response, error)

MetadataApiService Get server metadata Gets the metadata for the Hatchet instance.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ApiServerMetadata

type Module ¶

type Module struct {
	// the time that this resource was created
	CreatedAt               time.Time               `json:"created_at,omitempty"`
	CurrentEnvVarsVersionId string                  `json:"current_env_vars_version_id,omitempty"`
	CurrentValuesVersionId  string                  `json:"current_values_version_id,omitempty"`
	Deployment              *ModuleDeploymentConfig `json:"deployment,omitempty"`
	// the id of this resource, in UUID format
	Id       string `json:"id,omitempty"`
	LockId   string `json:"lock_id,omitempty"`
	LockKind string `json:"lock_kind,omitempty"`
	// the name for the module
	Name string `json:"name,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type ModuleDeploymentConfig ¶

type ModuleDeploymentConfig struct {
	GithubAppInstallationId string `json:"github_app_installation_id,omitempty"`
	GithubRepoBranch        string `json:"github_repo_branch,omitempty"`
	GithubRepoName          string `json:"github_repo_name,omitempty"`
	GithubRepoOwner         string `json:"github_repo_owner,omitempty"`
	Path                    string `json:"path,omitempty"`
}

type ModuleEnvVar ¶

type ModuleEnvVar struct {
	Key string `json:"key,omitempty"`
	Val string `json:"val,omitempty"`
}

type ModuleEnvVarsVersion ¶

type ModuleEnvVarsVersion struct {
	// the time that this resource was created
	CreatedAt time.Time      `json:"created_at,omitempty"`
	EnvVars   []ModuleEnvVar `json:"env_vars,omitempty"`
	// the id of this resource, in UUID format
	Id string `json:"id,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	Version   int32     `json:"version,omitempty"`
}

type ModuleMonitor ¶

type ModuleMonitor struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the cron schedule for the monitor
	CronSchedule string `json:"cron_schedule,omitempty"`
	// the description for the monitor
	Description string `json:"description,omitempty"`
	// whether the monitor is currently disabled
	Disabled bool `json:"disabled,omitempty"`
	// the id of this resource, in UUID format
	Id string `json:"id,omitempty"`
	// whether this monitor is a default for all modules in the team
	IsDefault bool   `json:"is_default,omitempty"`
	Kind      string `json:"kind,omitempty"`
	// The list of modules that this monitor filters for
	Modules []string `json:"modules,omitempty"`
	// the name for the monitor
	Name string `json:"name,omitempty"`
	// the policy bytes for the monitor
	PolicyBytes string `json:"policy_bytes,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type ModuleMonitorMeta ¶

type ModuleMonitorMeta struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the cron schedule for the monitor
	CronSchedule string `json:"cron_schedule,omitempty"`
	// the description for the monitor
	Description string `json:"description,omitempty"`
	// whether the monitor is currently disabled
	Disabled bool `json:"disabled,omitempty"`
	// the id of this resource, in UUID format
	Id string `json:"id,omitempty"`
	// whether this monitor is a default for all modules in the team
	IsDefault bool   `json:"is_default,omitempty"`
	Kind      string `json:"kind,omitempty"`
	// the name for the monitor
	Name string `json:"name,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type ModuleMonitorResult ¶

type ModuleMonitorResult struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id              string `json:"id,omitempty"`
	Message         string `json:"message,omitempty"`
	ModuleId        string `json:"module_id,omitempty"`
	ModuleMonitorId string `json:"module_monitor_id,omitempty"`
	ModuleName      string `json:"module_name,omitempty"`
	ModuleRunId     string `json:"module_run_id,omitempty"`
	Severity        string `json:"severity,omitempty"`
	Status          string `json:"status,omitempty"`
	Title           string `json:"title,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type ModulePlannedChangeSummary ¶

type ModulePlannedChangeSummary struct {
	Actions []string `json:"actions,omitempty"`
	Address string   `json:"address,omitempty"`
}

type ModuleRun ¶

type ModuleRun struct {
	Config *ModuleRunConfig `json:"config,omitempty"`
	// the time that this resource was created
	CreatedAt         time.Time          `json:"created_at,omitempty"`
	GithubPullRequest *GithubPullRequest `json:"github_pull_request,omitempty"`
	// the id of this resource, in UUID format
	Id                string                `json:"id,omitempty"`
	Kind              string                `json:"kind,omitempty"`
	MonitorResults    []ModuleMonitorResult `json:"monitor_results,omitempty"`
	Monitors          []ModuleMonitor       `json:"monitors,omitempty"`
	Status            string                `json:"status,omitempty"`
	StatusDescription string                `json:"status_description,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type ModuleRunConfig ¶

type ModuleRunConfig struct {
	EnvVarVersionId string `json:"env_var_version_id,omitempty"`
	GithubCommitSha string `json:"github_commit_sha,omitempty"`
	TriggerKind     string `json:"trigger_kind,omitempty"`
	ValuesVersionId string `json:"values_version_id,omitempty"`
}

type ModuleRunOverview ¶

type ModuleRunOverview struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id                string `json:"id,omitempty"`
	Kind              string `json:"kind,omitempty"`
	Status            string `json:"status,omitempty"`
	StatusDescription string `json:"status_description,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type ModuleValues ¶

type ModuleValues struct {
	// the time that this resource was created
	CreatedAt time.Time                 `json:"created_at,omitempty"`
	Github    *ModuleValuesGithubConfig `json:"github,omitempty"`
	// the id of this resource, in UUID format
	Id string `json:"id,omitempty"`
	// Raw values (may be omitted)
	RawValues map[string]interface{} `json:"raw_values,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	Version   int32     `json:"version,omitempty"`
}

type ModuleValuesGithubConfig ¶

type ModuleValuesGithubConfig struct {
	GithubAppInstallationId string `json:"github_app_installation_id,omitempty"`
	GithubRepoBranch        string `json:"github_repo_branch,omitempty"`
	GithubRepoName          string `json:"github_repo_name,omitempty"`
	GithubRepoOwner         string `json:"github_repo_owner,omitempty"`
	Path                    string `json:"path,omitempty"`
}

type ModulesApiGetCurrentModuleValuesOpts ¶

type ModulesApiGetCurrentModuleValuesOpts struct {
	GithubSha optional.String
}

type ModulesApiGetModuleTarballURLOpts ¶

type ModulesApiGetModuleTarballURLOpts struct {
	GithubSha optional.String
}

type ModulesApiListModuleRunsOpts ¶

type ModulesApiListModuleRunsOpts struct {
	Page   optional.Int64
	Status optional.Interface
	Kind   optional.Interface
}

type ModulesApiListModulesOpts ¶

type ModulesApiListModulesOpts struct {
	Page optional.Int64
}

type ModulesApiService ¶

type ModulesApiService service

func (*ModulesApiService) CreateModule ¶

func (a *ModulesApiService) CreateModule(ctx context.Context, body CreateModuleRequest, teamId string) (CreateModuleResponse, *http.Response, error)

ModulesApiService Create Module Creates a new module.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The module to create
@param teamId The team id

@return CreateModuleResponse

func (*ModulesApiService) CreateModuleRun ¶

func (a *ModulesApiService) CreateModuleRun(ctx context.Context, body CreateModuleRunRequest, teamId string, moduleId string) (CreateModuleRunResponse, *http.Response, error)

ModulesApiService Create Module Run Creates a new module run.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The module run to create
@param teamId The team id
@param moduleId The module id

@return CreateModuleRunResponse

func (*ModulesApiService) CreateMonitorResult ¶

func (a *ModulesApiService) CreateMonitorResult(ctx context.Context, body CreateMonitorResultRequest, teamId string, moduleId string, moduleRunId string) (*http.Response, error)

ModulesApiService Create Monitor Result Reports a monitor result.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The monitor result
@param teamId The team id
@param moduleId The module id
@param moduleRunId The module run id

func (*ModulesApiService) CreateTerraformPlan ¶

func (a *ModulesApiService) CreateTerraformPlan(ctx context.Context, body CreateTerraformPlanRequest, teamId string, moduleId string, moduleRunId string) (*http.Response, error)

ModulesApiService Create Terraform plan Creates a `POST` request for a Terraform plan. **Should only be called by Terraform in automation.**

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The terraform plan contents
@param teamId The team id
@param moduleId The module id
@param moduleRunId The module run id

func (*ModulesApiService) CreateTerraformState ¶

func (a *ModulesApiService) CreateTerraformState(ctx context.Context, teamId string, moduleId string, moduleRunId string) (*http.Response, error)

ModulesApiService Create or Update Terraform State Creates a `POST` request for Terraform state. **Should only be called by Terraform in automation.**

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param moduleId The module id
@param moduleRunId The module run id

func (*ModulesApiService) DeleteModule ¶

func (a *ModulesApiService) DeleteModule(ctx context.Context, teamId string, moduleId string) (DeleteModuleResponse, *http.Response, error)

ModulesApiService Delete Module Triggers module deletion. First triggers destroy for the Terraform module.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param moduleId The module id

@return DeleteModuleResponse

func (*ModulesApiService) FinalizeModuleRun ¶

func (a *ModulesApiService) FinalizeModuleRun(ctx context.Context, body FinalizeModuleRunRequest, teamId string, moduleId string, moduleRunId string) (FinalizeModuleRunResponse, *http.Response, error)

ModulesApiService Finalize module run Updates a module run with a finalized status.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The module run status to update
@param teamId The team id
@param moduleId The module id
@param moduleRunId The module run id

@return FinalizeModuleRunResponse

func (*ModulesApiService) ForceUnlockModule ¶

func (a *ModulesApiService) ForceUnlockModule(ctx context.Context) (ForceUnlockModuleResponse, *http.Response, error)

ModulesApiService Unlock Module Force unlocks a module.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ForceUnlockModuleResponse

func (*ModulesApiService) GetCurrentModuleValues ¶

func (a *ModulesApiService) GetCurrentModuleValues(ctx context.Context, teamId string, moduleId string, localVarOptionals *ModulesApiGetCurrentModuleValuesOpts) (map[string]interface{}, *http.Response, error)

func (*ModulesApiService) GetModule ¶

func (a *ModulesApiService) GetModule(ctx context.Context, teamId string, moduleId string) (GetModuleResponse, *http.Response, error)

ModulesApiService Get module Gets a module by module id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param moduleId The module id

@return GetModuleResponse

func (*ModulesApiService) GetModuleEnvVars ¶

func (a *ModulesApiService) GetModuleEnvVars(ctx context.Context, teamId string, moduleId string, moduleEnvVarsId string) (GetModuleEnvVarsVersionResponse, *http.Response, error)

ModulesApiService Get Module Env Vars Gets the module env vars version by id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param moduleId The module id
@param moduleEnvVarsId The module env vars version id

@return GetModuleEnvVarsVersionResponse

func (*ModulesApiService) GetModuleRun ¶

func (a *ModulesApiService) GetModuleRun(ctx context.Context, teamId string, moduleId string, moduleRunId string) (GetModuleRunResponse, *http.Response, error)

ModulesApiService Get module run Gets a module run.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param moduleId The module id
@param moduleRunId The module run id

@return GetModuleRunResponse

func (*ModulesApiService) GetModuleRunLocalToken ¶

func (a *ModulesApiService) GetModuleRunLocalToken(ctx context.Context, teamId string, moduleId string, moduleRunId string) (GetModuleRunTokenResponse, *http.Response, error)

ModulesApiService Get Module Run Token (Local) Gets a module run token for a local run.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param moduleId The module id
@param moduleRunId The module run id

@return GetModuleRunTokenResponse

func (*ModulesApiService) GetModuleRunLogs ¶

func (a *ModulesApiService) GetModuleRunLogs(ctx context.Context, teamId string, moduleId string, moduleRunId string) (GetLogsResponse, *http.Response, error)

ModulesApiService Get logs Gets the logs for a module run.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param moduleId The module id
@param moduleRunId The module run id

@return GetLogsResponse

func (*ModulesApiService) GetModuleRunPlanSummary ¶

func (a *ModulesApiService) GetModuleRunPlanSummary(ctx context.Context) ([]ModulePlannedChangeSummary, *http.Response, error)

ModulesApiService Get plan summary Gets the plan summary for a module run.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []ModulePlannedChangeSummary

func (*ModulesApiService) GetModuleTarballURL ¶

func (a *ModulesApiService) GetModuleTarballURL(ctx context.Context, teamId string, moduleId string, localVarOptionals *ModulesApiGetModuleTarballURLOpts) (GetModuleTarballUrlResponse, *http.Response, error)

func (*ModulesApiService) GetModuleValues ¶

func (a *ModulesApiService) GetModuleValues(ctx context.Context) (GetModuleValuesResponse, *http.Response, error)

ModulesApiService Get Module Values Gets the current module values by ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetModuleValuesResponse

func (*ModulesApiService) GetTerraformState ¶

func (a *ModulesApiService) GetTerraformState(ctx context.Context, teamId string, moduleId string, moduleRunId string) (*http.Response, error)

ModulesApiService Create or Update Terraform State Creates a `GET` request for Terraform state. **Should only be called by Terraform in automation.**

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param moduleId The module id
@param moduleRunId The module run id

func (*ModulesApiService) ListModuleRuns ¶

func (a *ModulesApiService) ListModuleRuns(ctx context.Context, teamId string, moduleId string, localVarOptionals *ModulesApiListModuleRunsOpts) (ListModuleRunsResponse, *http.Response, error)

func (*ModulesApiService) ListModules ¶

func (a *ModulesApiService) ListModules(ctx context.Context, teamId string, localVarOptionals *ModulesApiListModulesOpts) (ListModulesResponse, *http.Response, error)

func (*ModulesApiService) UpdateModule ¶

func (a *ModulesApiService) UpdateModule(ctx context.Context, teamId string, moduleId string, localVarOptionals *ModulesApiUpdateModuleOpts) (UpdateModuleResponse, *http.Response, error)

type ModulesApiUpdateModuleOpts ¶

type ModulesApiUpdateModuleOpts struct {
	Body optional.Interface
}

type MonitorsApiCreateMonitorOpts ¶

type MonitorsApiCreateMonitorOpts struct {
	Body optional.Interface
}

type MonitorsApiListMonitorResultsOpts ¶

type MonitorsApiListMonitorResultsOpts struct {
	Page            optional.Int64
	ModuleMonitorId optional.String
	ModuleId        optional.String
}

type MonitorsApiListMonitorsOpts ¶

type MonitorsApiListMonitorsOpts struct {
	Page optional.Int64
}

type MonitorsApiService ¶

type MonitorsApiService service

func (*MonitorsApiService) CreateMonitor ¶

func (a *MonitorsApiService) CreateMonitor(ctx context.Context, teamId string, localVarOptionals *MonitorsApiCreateMonitorOpts) (CreateMonitorResponse, *http.Response, error)

func (*MonitorsApiService) DeleteMonitor ¶

func (a *MonitorsApiService) DeleteMonitor(ctx context.Context, teamId string, monitorId string) (DeleteMonitorResponse, *http.Response, error)

MonitorsApiService Delete Monitor Deletes a monitor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param monitorId The monitor id

@return DeleteMonitorResponse

func (*MonitorsApiService) GetMonitor ¶

func (a *MonitorsApiService) GetMonitor(ctx context.Context, teamId string, monitorId string) (GetMonitorResponse, *http.Response, error)

MonitorsApiService Get Monitor Gets a monitor by id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param monitorId The monitor id

@return GetMonitorResponse

func (*MonitorsApiService) ListMonitorResults ¶

func (a *MonitorsApiService) ListMonitorResults(ctx context.Context, localVarOptionals *MonitorsApiListMonitorResultsOpts) (ListMonitorResultsResponse, *http.Response, error)

func (*MonitorsApiService) ListMonitors ¶

func (a *MonitorsApiService) ListMonitors(ctx context.Context, teamId string, localVarOptionals *MonitorsApiListMonitorsOpts) (ListMonitorsResponse, *http.Response, error)

func (*MonitorsApiService) UpdateMonitor ¶

func (a *MonitorsApiService) UpdateMonitor(ctx context.Context, teamId string, monitorId string, localVarOptionals *MonitorsApiUpdateMonitorOpts) (UpdateMonitorResponse, *http.Response, error)

type MonitorsApiUpdateMonitorOpts ¶

type MonitorsApiUpdateMonitorOpts struct {
	Body optional.Interface
}

type Notification ¶

type Notification struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id             string                `json:"id,omitempty"`
	LastNotified   time.Time             `json:"last_notified,omitempty"`
	Message        string                `json:"message,omitempty"`
	Module         *Module               `json:"module,omitempty"`
	ModuleId       string                `json:"module_id,omitempty"`
	MonitorResults []ModuleMonitorResult `json:"monitor_results,omitempty"`
	NotificationId string                `json:"notification_id,omitempty"`
	Resolved       bool                  `json:"resolved,omitempty"`
	Runs           []ModuleRun           `json:"runs,omitempty"`
	TeamId         string                `json:"team_id,omitempty"`
	Title          string                `json:"title,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type NotificationMeta ¶

type NotificationMeta struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id             string    `json:"id,omitempty"`
	LastNotified   time.Time `json:"last_notified,omitempty"`
	Message        string    `json:"message,omitempty"`
	ModuleId       string    `json:"module_id,omitempty"`
	NotificationId string    `json:"notification_id,omitempty"`
	Resolved       bool      `json:"resolved,omitempty"`
	TeamId         string    `json:"team_id,omitempty"`
	Title          string    `json:"title,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type Organization ¶

type Organization struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the display name for the team
	DisplayName string `json:"display_name,omitempty"`
	// the id of this resource, in UUID format
	Id    string                `json:"id,omitempty"`
	Owner *UserOrgPublishedData `json:"owner,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type OrganizationInvite ¶

type OrganizationInvite struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	Expires   time.Time `json:"expires,omitempty"`
	// the id of this resource, in UUID format
	Id            string `json:"id,omitempty"`
	InviteLinkUrl string `json:"invite_link_url,omitempty"`
	InviteeEmail  string `json:"invitee_email,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type OrganizationInviteSanitized ¶

type OrganizationInviteSanitized struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	Expires   time.Time `json:"expires,omitempty"`
	// the id of this resource, in UUID format
	Id           string `json:"id,omitempty"`
	InviteeEmail string `json:"invitee_email,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type OrganizationMember ¶

type OrganizationMember struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id                   string                   `json:"id,omitempty"`
	Invite               *OrganizationInvite      `json:"invite,omitempty"`
	InviteAccepted       bool                     `json:"invite_accepted,omitempty"`
	OrganizationPolicies []OrganizationPolicyMeta `json:"organization_policies,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time             `json:"updated_at,omitempty"`
	User      *UserOrgPublishedData `json:"user,omitempty"`
}

type OrganizationMemberSanitized ¶

type OrganizationMemberSanitized struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id                   string                       `json:"id,omitempty"`
	Invite               *OrganizationInviteSanitized `json:"invite,omitempty"`
	InviteAccepted       bool                         `json:"invite_accepted,omitempty"`
	OrganizationPolicies []OrganizationPolicyMeta     `json:"organization_policies,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time             `json:"updated_at,omitempty"`
	User      *UserOrgPublishedData `json:"user,omitempty"`
}

OrganizationMemberSanitized represents an organization member without a sensitive invite link exposed.

type OrganizationPolicyMeta ¶

type OrganizationPolicyMeta struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type OrganizationPolicyReference ¶

type OrganizationPolicyReference struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type OrganizationsApiCreateOrgMemberInviteOpts ¶

type OrganizationsApiCreateOrgMemberInviteOpts struct {
	Body optional.Interface
}

type OrganizationsApiCreateOrganizationOpts ¶

type OrganizationsApiCreateOrganizationOpts struct {
	Body optional.Interface
}

type OrganizationsApiListOrgMembersOpts ¶

type OrganizationsApiListOrgMembersOpts struct {
	OrgId optional.Int64
}

type OrganizationsApiService ¶

type OrganizationsApiService service

func (*OrganizationsApiService) AcceptOrgMemberInvite ¶

func (a *OrganizationsApiService) AcceptOrgMemberInvite(ctx context.Context, orgMemberInviteId string, orgMemberInviteTok string) (EmptyResponse, *http.Response, error)

OrganizationsApiService Accept an organization invite. Accept an invite for an organization.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgMemberInviteId The member invite id
@param orgMemberInviteTok The member invite token (sensitive)

@return EmptyResponse

func (*OrganizationsApiService) CreateOrgMemberInvite ¶

func (a *OrganizationsApiService) CreateOrgMemberInvite(ctx context.Context, orgId string, localVarOptionals *OrganizationsApiCreateOrgMemberInviteOpts) (CreateOrgMemberInviteResponse, *http.Response, error)

func (*OrganizationsApiService) CreateOrganization ¶

func (a *OrganizationsApiService) CreateOrganization(ctx context.Context, localVarOptionals *OrganizationsApiCreateOrganizationOpts) (CreateOrganizationResponse, *http.Response, error)

func (*OrganizationsApiService) DeleteOrg ¶

func (a *OrganizationsApiService) DeleteOrg(ctx context.Context) (DeleteOrganizationResponse, *http.Response, error)

OrganizationsApiService Delete organization. Delete an organization. Only owners can delete organizations.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return DeleteOrganizationResponse

func (*OrganizationsApiService) DeleteOrgMember ¶

func (a *OrganizationsApiService) DeleteOrgMember(ctx context.Context, orgId string) (EmptyResponse, *http.Response, error)

OrganizationsApiService Delete organization member. Delete an organization member. Only admins can delete an organization member. Owners cannot be removed from the organization, the owner must be transferred before the organization owner can be removed.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId The org id

@return EmptyResponse

func (*OrganizationsApiService) GetOrgMember ¶

func (a *OrganizationsApiService) GetOrgMember(ctx context.Context, orgId string, orgMemberId string) (GetOrgMemberResponse, *http.Response, error)

OrganizationsApiService Get organization member. Get organization member. Only admins and owner can read full member data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId The org id
@param orgMemberId The org member id

@return GetOrgMemberResponse

func (*OrganizationsApiService) GetOrganization ¶

func (a *OrganizationsApiService) GetOrganization(ctx context.Context, orgId string) (GetOrganizationResponse, *http.Response, error)

OrganizationsApiService Get an organization Retrieves an organization by the `org_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId The org id

@return GetOrganizationResponse

func (*OrganizationsApiService) LeaveOrg ¶

func (a *OrganizationsApiService) LeaveOrg(ctx context.Context, orgId string) (EmptyResponse, *http.Response, error)

OrganizationsApiService Leave an organization Leave an organization. The currently authenticated user will leave this organization. Owners cannot leave an organization without changing the owner first.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId The org id

@return EmptyResponse

func (*OrganizationsApiService) ListOrgMembers ¶

func (a *OrganizationsApiService) ListOrgMembers(ctx context.Context, localVarOptionals *OrganizationsApiListOrgMembersOpts) (ListOrgMembersResponse, *http.Response, error)

func (*OrganizationsApiService) UpdateOrgMemberPolicies ¶

func (a *OrganizationsApiService) UpdateOrgMemberPolicies(ctx context.Context, orgId string, orgMemberId string) (UpdateOrgMemberPoliciesResponse, *http.Response, error)

OrganizationsApiService Update organization member policies. Update an organization member's policies.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId The org id
@param orgMemberId The org member id

@return UpdateOrgMemberPoliciesResponse

func (*OrganizationsApiService) UpdateOrgOwner ¶

func (a *OrganizationsApiService) UpdateOrgOwner(ctx context.Context, orgId string) (EmptyResponse, *http.Response, error)

OrganizationsApiService Update organization owner. Update organization owner. Only owners may update organization owners. The previous owner will become an admin (and can subsequently be removed from the organization, if required).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId The org id

@return EmptyResponse

func (*OrganizationsApiService) UpdateOrganization ¶

func (a *OrganizationsApiService) UpdateOrganization(ctx context.Context, orgId string, localVarOptionals *OrganizationsApiUpdateOrganizationOpts) (UpdateOrgResponse, *http.Response, error)

type OrganizationsApiUpdateOrganizationOpts ¶

type OrganizationsApiUpdateOrganizationOpts struct {
	Body optional.Interface
}

type PaginationResponse ¶

type PaginationResponse struct {
	// the current page
	CurrentPage int64 `json:"current_page,omitempty"`
	// the next page
	NextPage int64 `json:"next_page,omitempty"`
	// the total number of pages for listing
	NumPages int64 `json:"num_pages,omitempty"`
}

type PersonalAccessToken ¶

type PersonalAccessToken struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the display name for the personal access token
	DisplayName string `json:"display_name,omitempty"`
	// when the token expires
	Expires time.Time `json:"expires,omitempty"`
	// the id of this resource, in UUID format
	Id string `json:"id,omitempty"`
	// whether the token has been revoked
	Revoked bool `json:"revoked,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type ResetPasswordEmailFinalizeRequest ¶

type ResetPasswordEmailFinalizeRequest struct {
	// the email address for this user
	Email string `json:"email"`
	// the new password for this user
	NewPassword string `json:"new_password"`
	// the token
	Token string `json:"token"`
	// the token id
	TokenId string `json:"token_id"`
}

type ResetPasswordEmailRequest ¶

type ResetPasswordEmailRequest struct {
	// the email address for this user
	Email string `json:"email"`
}

type ResetPasswordEmailVerifyRequest ¶

type ResetPasswordEmailVerifyRequest struct {
	// the email address for this user
	Email string `json:"email"`
	// the token
	Token string `json:"token"`
	// the token id
	TokenId string `json:"token_id"`
}

type ResetPasswordEmailVerifyTokenRequest ¶

type ResetPasswordEmailVerifyTokenRequest struct {
	// the email address for this user
	Email string `json:"email"`
	// the token
	Token string `json:"token"`
	// the token id
	TokenId string `json:"token_id"`
}

type ResetPasswordManualRequest ¶

type ResetPasswordManualRequest struct {
	// the new password for this user
	NewPassword string `json:"new_password"`
	// the old password for this user
	OldPassword string `json:"old_password"`
}

type RevokePatResponse ¶

type RevokePatResponse struct {
}

type RevokePatResponseExample ¶

type RevokePatResponseExample struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the display name for the personal access token
	DisplayName string `json:"display_name,omitempty"`
	// when the token expires
	Expires time.Time `json:"expires,omitempty"`
	// the id of this resource, in UUID format
	Id string `json:"id,omitempty"`
	// whether the token is revoked
	Revoked bool `json:"revoked,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type Team ¶

type Team struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the display name for the team
	DisplayName string `json:"display_name,omitempty"`
	// the id of this resource, in UUID format
	Id string `json:"id,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type TeamAddMemberRequest ¶

type TeamAddMemberRequest struct {
	// the organization member id of the new team member
	OrgMemberId string `json:"org_member_id,omitempty"`
	// the set of policies for this user
	Policies []TeamPolicyReference `json:"policies"`
}

type TeamAddMemberResponse ¶

type TeamAddMemberResponse struct {
}

type TeamMember ¶

type TeamMember struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id           string                       `json:"id,omitempty"`
	OrgMember    *OrganizationMemberSanitized `json:"org_member,omitempty"`
	TeamPolicies []TeamPolicyMeta             `json:"team_policies,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type TeamPolicyMeta ¶

type TeamPolicyMeta struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the id of this resource, in UUID format
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type TeamPolicyReference ¶

type TeamPolicyReference struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type TeamUpdateRequest ¶

type TeamUpdateRequest struct {
	// the display name for the team
	DisplayName string `json:"display_name"`
}

type TeamUpdateResponse ¶

type TeamUpdateResponse struct {
}

type TeamsApiAddTeamMemberOpts ¶

type TeamsApiAddTeamMemberOpts struct {
	Body optional.Interface
}

type TeamsApiCreateTeamOpts ¶

type TeamsApiCreateTeamOpts struct {
	Body optional.Interface
}

type TeamsApiListNotificationsOpts ¶

type TeamsApiListNotificationsOpts struct {
	OrgId optional.Int64
}

type TeamsApiListTeamMembersOpts ¶

type TeamsApiListTeamMembersOpts struct {
	TeamId optional.Int64
}

type TeamsApiListTeamsOpts ¶

type TeamsApiListTeamsOpts struct {
	OrgId optional.Int64
}

type TeamsApiService ¶

type TeamsApiService service

func (*TeamsApiService) AddTeamMember ¶

func (a *TeamsApiService) AddTeamMember(ctx context.Context, teamId string, localVarOptionals *TeamsApiAddTeamMemberOpts) (TeamAddMemberResponse, *http.Response, error)

func (*TeamsApiService) CreateTeam ¶

func (a *TeamsApiService) CreateTeam(ctx context.Context, orgId string, localVarOptionals *TeamsApiCreateTeamOpts) (CreateTeamResponse, *http.Response, error)

func (*TeamsApiService) DeleteTeam ¶

func (a *TeamsApiService) DeleteTeam(ctx context.Context, teamId string) (DeleteTeamResponse, *http.Response, error)

TeamsApiService Delete team. Delete a team. This operation cannot be undone.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id

@return DeleteTeamResponse

func (*TeamsApiService) DeleteTeamMember ¶

func (a *TeamsApiService) DeleteTeamMember(ctx context.Context, teamId string) (EmptyResponse, *http.Response, error)

TeamsApiService Delete team member Delete a team member.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team member id

@return EmptyResponse

func (*TeamsApiService) GetNotification ¶

func (a *TeamsApiService) GetNotification(ctx context.Context, teamId string) (GetNotificationResponse, *http.Response, error)

TeamsApiService Get notification Gets a notification by id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id

@return GetNotificationResponse

func (*TeamsApiService) GithubIncomingWebhook ¶

func (a *TeamsApiService) GithubIncomingWebhook(ctx context.Context, teamId string, githubIncomingWebhookId string) (*http.Response, error)

TeamsApiService Github incoming webhook endpoint Github incoming webhook handler.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param githubIncomingWebhookId The incoming webhook id

func (*TeamsApiService) ListNotifications ¶

func (a *TeamsApiService) ListNotifications(ctx context.Context, localVarOptionals *TeamsApiListNotificationsOpts) (ListNotificationsResponse, *http.Response, error)

func (*TeamsApiService) ListTeamMembers ¶

func (a *TeamsApiService) ListTeamMembers(ctx context.Context, localVarOptionals *TeamsApiListTeamMembersOpts) (ListTeamMembersResponse, *http.Response, error)

func (*TeamsApiService) ListTeams ¶

func (a *TeamsApiService) ListTeams(ctx context.Context, localVarOptionals *TeamsApiListTeamsOpts) (ListTeamsResponse, *http.Response, error)

func (*TeamsApiService) UpdateTeam ¶

func (a *TeamsApiService) UpdateTeam(ctx context.Context, teamId string, localVarOptionals *TeamsApiUpdateTeamOpts) (TeamUpdateResponse, *http.Response, error)

type TeamsApiUpdateTeamOpts ¶

type TeamsApiUpdateTeamOpts struct {
	Body optional.Interface
}

type TerraformLock ¶

type TerraformLock struct {
	Created   string `json:"Created,omitempty"`
	ID        string `json:"ID,omitempty"`
	Info      string `json:"Info,omitempty"`
	Operation string `json:"Operation,omitempty"`
	Path      string `json:"Path,omitempty"`
	Version   string `json:"Version,omitempty"`
	Who       string `json:"Who,omitempty"`
}

type TestsApiService ¶

type TestsApiService service

func (*TestsApiService) GetModuleTarballURL ¶

func (a *TestsApiService) GetModuleTarballURL(ctx context.Context, teamId string, moduleId string) (GetModuleTarballUrlResponse, *http.Response, error)

TestsApiService Get Module Tarball URL Gets the Github tarball URL for the module.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamId The team id
@param moduleId The module id

@return GetModuleTarballUrlResponse

type UpdateModuleRequest ¶

type UpdateModuleRequest struct {
	EnvVars      map[string]string                `json:"env_vars,omitempty"`
	Github       *CreateModuleRequestGithub       `json:"github,omitempty"`
	Name         string                           `json:"name,omitempty"`
	ValuesGithub *CreateModuleValuesRequestGithub `json:"values_github,omitempty"`
	ValuesRaw    map[string]interface{}           `json:"values_raw,omitempty"`
}

type UpdateModuleResponse ¶

type UpdateModuleResponse struct {
}

type UpdateMonitorRequest ¶

type UpdateMonitorRequest struct {
	CronSchedule string `json:"cron_schedule,omitempty"`
	Description  string `json:"description,omitempty"`
	// Whether the monitor is disabled. In order to turn the monitor off for all modules, set disabled=true. Passing in an empty module list will trigger this monitor for all modules.
	Disabled bool   `json:"disabled,omitempty"`
	Kind     string `json:"kind,omitempty"`
	// A list of module ids. If empty or omitted, this monitor targets all modules.
	Modules     []string `json:"modules,omitempty"`
	Name        string   `json:"name,omitempty"`
	PolicyBytes string   `json:"policy_bytes,omitempty"`
}

type UpdateMonitorResponse ¶

type UpdateMonitorResponse struct {
}

type UpdateOrgMemberPoliciesRequest ¶

type UpdateOrgMemberPoliciesRequest struct {
	// the set of policies for this user
	Policies []OrganizationPolicyReference `json:"policies"`
}

type UpdateOrgMemberPoliciesResponse ¶

type UpdateOrgMemberPoliciesResponse struct {
}

type UpdateOrgOwnerRequest ¶

type UpdateOrgOwnerRequest struct {
	// the member id of the new owner
	NewOwnerMemberId string `json:"new_owner_member_id,omitempty"`
}

type UpdateOrgRequest ¶

type UpdateOrgRequest struct {
	// the display name for this user
	DisplayName string `json:"display_name"`
}

type UpdateOrgResponse ¶

type UpdateOrgResponse struct {
}

type UpdateOrganizationRequest ¶

type UpdateOrganizationRequest struct {
	// the display name for this user
	DisplayName string `json:"display_name"`
}

type UpdateUserRequest ¶

type UpdateUserRequest struct {
	// the display name for this user
	DisplayName string `json:"display_name"`
}

type UpdateUserResponse ¶

type UpdateUserResponse struct {
}

type User ¶

type User struct {
	// the time that this resource was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// the display name for this user
	DisplayName string `json:"display_name,omitempty"`
	// the email address for this user
	Email string `json:"email,omitempty"`
	// whether this user's email address has been verified
	EmailVerified bool `json:"email_verified,omitempty"`
	// a URI for the user icon
	Icon string `json:"icon,omitempty"`
	// the id of this resource, in UUID format
	Id string `json:"id,omitempty"`
	// the time that this resource was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type UserOrgPublishedData ¶

type UserOrgPublishedData struct {
	// the display name for this user
	DisplayName string `json:"display_name,omitempty"`
	// the email address for this user
	Email string `json:"email,omitempty"`
}

Public data about the user that other members of the org and team can access

type UsersApiCreatePersonalAccessTokenOpts ¶

type UsersApiCreatePersonalAccessTokenOpts struct {
	Body optional.Interface
}

type UsersApiCreateUserOpts ¶

type UsersApiCreateUserOpts struct {
	Body optional.Interface
}

type UsersApiListGithubAppInstallationsOpts ¶

type UsersApiListGithubAppInstallationsOpts struct {
	Page optional.Int64
}

type UsersApiListPersonalAccessTokensOpts ¶

type UsersApiListPersonalAccessTokensOpts struct {
	Page optional.Int64
}

type UsersApiListUserOrganizationsOpts ¶

type UsersApiListUserOrganizationsOpts struct {
	Page optional.Int64
}

type UsersApiListUserTeamsOpts ¶

type UsersApiListUserTeamsOpts struct {
	Page           optional.Int64
	OrganizationId optional.String
}

type UsersApiLoginUserOpts ¶

type UsersApiLoginUserOpts struct {
	Body optional.Interface
}

type UsersApiResetPasswordEmailFinalizeOpts ¶

type UsersApiResetPasswordEmailFinalizeOpts struct {
	Body optional.Interface
}

type UsersApiResetPasswordEmailOpts ¶

type UsersApiResetPasswordEmailOpts struct {
	Body optional.Interface
}

type UsersApiResetPasswordEmailVerifyOpts ¶

type UsersApiResetPasswordEmailVerifyOpts struct {
	Body optional.Interface
}

type UsersApiResetPasswordManualOpts ¶

type UsersApiResetPasswordManualOpts struct {
	Body optional.Interface
}

type UsersApiService ¶

type UsersApiService service

func (*UsersApiService) CreatePersonalAccessToken ¶

func (a *UsersApiService) CreatePersonalAccessToken(ctx context.Context, localVarOptionals *UsersApiCreatePersonalAccessTokenOpts) (CreatePatResponse, *http.Response, error)

func (*UsersApiService) CreateUser ¶

func (a *UsersApiService) CreateUser(ctx context.Context, localVarOptionals *UsersApiCreateUserOpts) (CreateUserResponse, *http.Response, error)

func (*UsersApiService) DeleteCurrentUser ¶

func (a *UsersApiService) DeleteCurrentUser(ctx context.Context) (EmptyResponse, *http.Response, error)

UsersApiService Delete the current user. Deletes the current user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return EmptyResponse

func (*UsersApiService) DeletePersonalAccessToken ¶

func (a *UsersApiService) DeletePersonalAccessToken(ctx context.Context, patId string) (DeletePatResponse, *http.Response, error)

UsersApiService Delete the personal access token. Deletes the personal access token for the user

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param patId The personal access token id

@return DeletePatResponse

func (*UsersApiService) GetCurrentUser ¶

func (a *UsersApiService) GetCurrentUser(ctx context.Context) (GetUserResponse, *http.Response, error)

UsersApiService Retrieve the current user. Retrieves the current user object based on the data passed in auth.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetUserResponse

func (*UsersApiService) GetPersonalAccessToken ¶

func (a *UsersApiService) GetPersonalAccessToken(ctx context.Context, patId string) (GetPatResponse, *http.Response, error)

UsersApiService Get a personal access token Gets a personal access token for a user, specified by the path param `pat_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param patId The personal access token id

@return GetPatResponse

func (*UsersApiService) ListGithubAppInstallations ¶

func (a *UsersApiService) ListGithubAppInstallations(ctx context.Context, localVarOptionals *UsersApiListGithubAppInstallationsOpts) (ListGithubAppInstallationsResponse, *http.Response, error)

func (*UsersApiService) ListPersonalAccessTokens ¶

func (a *UsersApiService) ListPersonalAccessTokens(ctx context.Context, localVarOptionals *UsersApiListPersonalAccessTokensOpts) (ListPatsResponse, *http.Response, error)

func (*UsersApiService) ListUserOrganizations ¶

func (a *UsersApiService) ListUserOrganizations(ctx context.Context, localVarOptionals *UsersApiListUserOrganizationsOpts) (ListUserOrgsResponse, *http.Response, error)

func (*UsersApiService) ListUserTeams ¶

func (a *UsersApiService) ListUserTeams(ctx context.Context, localVarOptionals *UsersApiListUserTeamsOpts) (ListUserTeamsResponse, *http.Response, error)

func (*UsersApiService) LoginUser ¶

func (a *UsersApiService) LoginUser(ctx context.Context, localVarOptionals *UsersApiLoginUserOpts) (LoginUserResponse, *http.Response, error)

func (*UsersApiService) LogoutUser ¶

func (a *UsersApiService) LogoutUser(ctx context.Context) (EmptyResponse, *http.Response, error)

UsersApiService Logout user Logs a user out. This endpoint only performs an action if it's called with cookie-based authentication.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return EmptyResponse

func (*UsersApiService) ResendVerificationEmail ¶

func (a *UsersApiService) ResendVerificationEmail(ctx context.Context) (EmptyResponse, *http.Response, error)

UsersApiService Resend verification email. Resends a verification email for the user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return EmptyResponse

func (*UsersApiService) ResetPasswordEmail ¶

func (a *UsersApiService) ResetPasswordEmail(ctx context.Context, localVarOptionals *UsersApiResetPasswordEmailOpts) (EmptyResponse, *http.Response, error)

func (*UsersApiService) ResetPasswordEmailFinalize ¶

func (a *UsersApiService) ResetPasswordEmailFinalize(ctx context.Context, localVarOptionals *UsersApiResetPasswordEmailFinalizeOpts) (EmptyResponse, *http.Response, error)

func (*UsersApiService) ResetPasswordEmailVerify ¶

func (a *UsersApiService) ResetPasswordEmailVerify(ctx context.Context, localVarOptionals *UsersApiResetPasswordEmailVerifyOpts) (EmptyResponse, *http.Response, error)

func (*UsersApiService) ResetPasswordManual ¶

func (a *UsersApiService) ResetPasswordManual(ctx context.Context, localVarOptionals *UsersApiResetPasswordManualOpts) (EmptyResponse, *http.Response, error)

func (*UsersApiService) RevokePersonalAccessToken ¶

func (a *UsersApiService) RevokePersonalAccessToken(ctx context.Context, patId string) (RevokePatResponseExample, *http.Response, error)

UsersApiService Revoke the personal access token. Revokes the personal access token for the user

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param patId The personal access token id

@return RevokePatResponseExample

func (*UsersApiService) UpdateCurrentUser ¶

func (a *UsersApiService) UpdateCurrentUser(ctx context.Context, localVarOptionals *UsersApiUpdateCurrentUserOpts) (UpdateUserResponse, *http.Response, error)

func (*UsersApiService) VerifyEmail ¶

func (a *UsersApiService) VerifyEmail(ctx context.Context, localVarOptionals *UsersApiVerifyEmailOpts) (EmptyResponse, *http.Response, error)

type UsersApiUpdateCurrentUserOpts ¶

type UsersApiUpdateCurrentUserOpts struct {
	Body optional.Interface
}

type UsersApiVerifyEmailOpts ¶

type UsersApiVerifyEmailOpts struct {
	Body optional.Interface
}

type VerifyEmailRequest ¶

type VerifyEmailRequest struct {
	// the token
	Token string `json:"token"`
	// the token id
	TokenId string `json:"token_id"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL