api

package

Go to main page

Versions in this module

v0

v0.6.0-beta.1

Jan 4, 2026

v0.5.3

Jan 5, 2026

v0.5.2

Jan 4, 2026

Changes in this version

type Client

+ func (c *Client) LinkProject(ctx context.Context, repo string, opts SyncOptions) (*ProjectLink, error)

+ type ProjectLink struct

+ ID string

+ IsNew bool

+ KeywayEnvironment string

+ LastSyncedAt *string

+ ProjectID string

+ ProjectName *string

+ ProviderEnvironment string

v0.5.1

Jan 4, 2026

Changes in this version

type APIClient

+ GetVaultDetails func(ctx context.Context, repoFullName string) (*VaultDetails, error)

type Client

+ func (c *Client) GetVaultDetails(ctx context.Context, repoFullName string) (*VaultDetails, error)

type MockClient

+ GetVaultDetailsFn func(ctx context.Context, repoFullName string) (*VaultDetails, error)

+ func (m *MockClient) GetVaultDetails(ctx context.Context, repoFullName string) (*VaultDetails, error)

+ type VaultDetails struct

+ ID string

+ RepoFullName string

+ SecretCount int

v0.5.0

Jan 1, 2026

Changes in this version

type ValidateTokenResponse

+ CreatedAt string

+ Plan string

v0.4.1

Jan 1, 2026

v0.4.0

Dec 26, 2025

v0.3.11

Dec 26, 2025

v0.3.10

Dec 26, 2025

Changes in this version

+ type APIClient interface

+ CheckGitHubAppInstallation func(ctx context.Context, repoOwner, repoName string) (*GitHubAppInstallationStatus, error)

+ CheckVaultExists func(ctx context.Context, repoFullName string) (bool, error)

+ ConnectWithToken func(ctx context.Context, provider, providerToken string) (*ConnectTokenResponse, error)

+ DeleteConnection func(ctx context.Context, connectionID string) error

+ ExecuteSync func(ctx context.Context, repo string, opts SyncOptions) (*SyncResult, error)

+ GetAllProviderProjects func(ctx context.Context, provider string) ([]ProviderProject, []Connection, error)

+ GetConnections func(ctx context.Context) ([]Connection, error)

+ GetProviderAuthURL func(provider string) string

+ GetProviders func(ctx context.Context) ([]Provider, error)

+ GetRepoIdsFromBackend func(ctx context.Context, repoFullName string) (*RepoIds, error)

+ GetSyncDiff func(ctx context.Context, repo string, opts SyncOptions) (*SyncDiff, error)

+ GetSyncPreview func(ctx context.Context, repo string, opts SyncOptions) (*SyncPreview, error)

+ GetSyncStatus func(ctx context.Context, repo, connectionID, projectID, environment string) (*SyncStatus, error)

+ GetVaultEnvironments func(ctx context.Context, repoFullName string) ([]string, error)

+ InitVault func(ctx context.Context, repoFullName string) (*InitVaultResponse, error)

+ PollDeviceLogin func(ctx context.Context, deviceCode string) (*DevicePollResponse, error)

+ PullSecrets func(ctx context.Context, repo, env string) (*PullSecretsResponse, error)

+ PushSecrets func(ctx context.Context, repo, env string, secrets map[string]string) (*PushSecretsResponse, error)

+ StartDeviceLogin func(ctx context.Context, repository string, repoIds *RepoIds) (*DeviceStartResponse, error)

+ StartOrganizationTrial func(ctx context.Context, orgLogin string) (*StartTrialResponse, error)

+ ValidateToken func(ctx context.Context) (*ValidateTokenResponse, error)

+ type APIError struct

+ Detail string

+ StatusCode int

+ Title string

+ TrialInfo *TrialEligibility

+ Type string

+ UpgradeURL string

+ func (e *APIError) Error() string

+ type Client struct

+ func NewClient(token string) *Client

+ func NewClientWithVersion(token, version string) *Client

+ func (c *Client) CanStartTrial(ctx context.Context, orgLogin string) (bool, int, error)

+ func (c *Client) CheckGitHubAppInstallation(ctx context.Context, repoOwner, repoName string) (*GitHubAppInstallationStatus, error)

+ func (c *Client) CheckVaultExists(ctx context.Context, repoFullName string) (bool, error)

+ func (c *Client) ConnectWithToken(ctx context.Context, provider, providerToken string) (*ConnectTokenResponse, error)

+ func (c *Client) DeleteConnection(ctx context.Context, connectionID string) error

+ func (c *Client) ExecuteSync(ctx context.Context, repo string, opts SyncOptions) (*SyncResult, error)

+ func (c *Client) GetAllProviderProjects(ctx context.Context, provider string) ([]ProviderProject, []Connection, error)

+ func (c *Client) GetConnections(ctx context.Context) ([]Connection, error)

+ func (c *Client) GetOrganization(ctx context.Context, orgLogin string) (*OrganizationInfo, error)

+ func (c *Client) GetProviderAuthURL(provider string) string

+ func (c *Client) GetProviders(ctx context.Context) ([]Provider, error)

+ func (c *Client) GetRepoIdsFromBackend(ctx context.Context, repoFullName string) (*RepoIds, error)

+ func (c *Client) GetSyncDiff(ctx context.Context, repo string, opts SyncOptions) (*SyncDiff, error)

+ func (c *Client) GetSyncPreview(ctx context.Context, repo string, opts SyncOptions) (*SyncPreview, error)

+ func (c *Client) GetSyncStatus(ctx context.Context, repo, connectionID, projectID, environment string) (*SyncStatus, error)

+ func (c *Client) GetVaultEnvironments(ctx context.Context, repoFullName string) ([]string, error)

+ func (c *Client) InitVault(ctx context.Context, repoFullName string) (*InitVaultResponse, error)

+ func (c *Client) PollDeviceLogin(ctx context.Context, deviceCode string) (*DevicePollResponse, error)

+ func (c *Client) PullSecrets(ctx context.Context, repo, env string) (*PullSecretsResponse, error)

+ func (c *Client) PushSecrets(ctx context.Context, repo, env string, secrets map[string]string) (*PushSecretsResponse, error)

+ func (c *Client) SetTimeout(timeout time.Duration)

+ func (c *Client) StartDeviceLogin(ctx context.Context, repository string, repoIds *RepoIds) (*DeviceStartResponse, error)

+ func (c *Client) StartOrganizationTrial(ctx context.Context, orgLogin string) (*StartTrialResponse, error)

+ func (c *Client) ValidateToken(ctx context.Context) (*ValidateTokenResponse, error)

+ type ConnectTokenResponse struct

+ Success bool

+ User struct{ ... }

+ type Connection struct

+ CreatedAt string

+ ID string

+ Provider string

+ ProviderTeamID *string

+ type DevicePollResponse struct

+ ExpiresAt string

+ GitHubLogin string

+ KeywayToken string

+ Message string

+ Status string

+ type DeviceStartResponse struct

+ DeviceCode string

+ ExpiresIn int

+ GitHubAppInstallURL string

+ Interval int

+ UserCode string

+ VerificationURI string

+ VerificationURIComplete string

+ type GitHubAppInstallationStatus struct

+ InstallURL string

+ InstallationID int

+ Installed bool

+ Message string

+ type InitVaultResponse struct

+ Message string

+ RepoFullName string

+ VaultID string

+ type MockClient struct

+ Calls map[string]int

+ CheckGitHubAppInstallationFn func(ctx context.Context, repoOwner, repoName string) (*GitHubAppInstallationStatus, error)

+ CheckVaultExistsFn func(ctx context.Context, repoFullName string) (bool, error)

+ ConnectWithTokenFn func(ctx context.Context, provider, providerToken string) (*ConnectTokenResponse, error)

+ DeleteConnectionFn func(ctx context.Context, connectionID string) error

+ ExecuteSyncFn func(ctx context.Context, repo string, opts SyncOptions) (*SyncResult, error)

+ GetAllProviderProjectsFn func(ctx context.Context, provider string) ([]ProviderProject, []Connection, error)

+ GetConnectionsFn func(ctx context.Context) ([]Connection, error)

+ GetProviderAuthURLFn func(provider string) string

+ GetProvidersFn func(ctx context.Context) ([]Provider, error)

+ GetRepoIdsFromBackendFn func(ctx context.Context, repoFullName string) (*RepoIds, error)

+ GetSyncDiffFn func(ctx context.Context, repo string, opts SyncOptions) (*SyncDiff, error)

+ GetSyncPreviewFn func(ctx context.Context, repo string, opts SyncOptions) (*SyncPreview, error)

+ GetSyncStatusFn func(ctx context.Context, repo, connectionID, projectID, environment string) (*SyncStatus, error)

+ GetVaultEnvironmentsFn func(ctx context.Context, repoFullName string) ([]string, error)

+ InitVaultFn func(ctx context.Context, repoFullName string) (*InitVaultResponse, error)

+ PollDeviceLoginFn func(ctx context.Context, deviceCode string) (*DevicePollResponse, error)

+ PullSecretsFn func(ctx context.Context, repo, env string) (*PullSecretsResponse, error)

+ PushSecretsFn func(ctx context.Context, repo, env string, secrets map[string]string) (*PushSecretsResponse, error)

+ StartDeviceLoginFn func(ctx context.Context, repository string, repoIds *RepoIds) (*DeviceStartResponse, error)

+ ValidateTokenFn func(ctx context.Context) (*ValidateTokenResponse, error)

+ func NewMockClient() *MockClient

+ func (m *MockClient) CheckGitHubAppInstallation(ctx context.Context, repoOwner, repoName string) (*GitHubAppInstallationStatus, error)

+ func (m *MockClient) CheckVaultExists(ctx context.Context, repoFullName string) (bool, error)

+ func (m *MockClient) ConnectWithToken(ctx context.Context, provider, providerToken string) (*ConnectTokenResponse, error)

+ func (m *MockClient) DeleteConnection(ctx context.Context, connectionID string) error

+ func (m *MockClient) ExecuteSync(ctx context.Context, repo string, opts SyncOptions) (*SyncResult, error)

+ func (m *MockClient) GetAllProviderProjects(ctx context.Context, provider string) ([]ProviderProject, []Connection, error)

+ func (m *MockClient) GetConnections(ctx context.Context) ([]Connection, error)

+ func (m *MockClient) GetProviderAuthURL(provider string) string

+ func (m *MockClient) GetProviders(ctx context.Context) ([]Provider, error)

+ func (m *MockClient) GetRepoIdsFromBackend(ctx context.Context, repoFullName string) (*RepoIds, error)

+ func (m *MockClient) GetSyncDiff(ctx context.Context, repo string, opts SyncOptions) (*SyncDiff, error)

+ func (m *MockClient) GetSyncPreview(ctx context.Context, repo string, opts SyncOptions) (*SyncPreview, error)

+ func (m *MockClient) GetSyncStatus(ctx context.Context, repo, connectionID, projectID, environment string) (*SyncStatus, error)

+ func (m *MockClient) GetVaultEnvironments(ctx context.Context, repoFullName string) ([]string, error)

+ func (m *MockClient) InitVault(ctx context.Context, repoFullName string) (*InitVaultResponse, error)

+ func (m *MockClient) PollDeviceLogin(ctx context.Context, deviceCode string) (*DevicePollResponse, error)

+ func (m *MockClient) PullSecrets(ctx context.Context, repo, env string) (*PullSecretsResponse, error)

+ func (m *MockClient) PushSecrets(ctx context.Context, repo, env string, secrets map[string]string) (*PushSecretsResponse, error)

+ func (m *MockClient) StartDeviceLogin(ctx context.Context, repository string, repoIds *RepoIds) (*DeviceStartResponse, error)

+ func (m *MockClient) StartOrganizationTrial(ctx context.Context, orgLogin string) (*StartTrialResponse, error)

+ func (m *MockClient) ValidateToken(ctx context.Context) (*ValidateTokenResponse, error)

+ type OrganizationInfo struct

+ AvatarURL string

+ DisplayName string

+ EffectivePlan string

+ ID string

+ Login string

+ MemberCount int

+ Plan string

+ Role string

+ Trial TrialInfo

+ VaultCount int

+ type Provider struct

+ Configured bool

+ DisplayName string

+ Name string

+ type ProviderProject struct

+ ConnectionID string

+ Environments []string

+ ID string

+ LinkedRepo *string

+ Name string

+ ServiceID *string

+ ServiceName *string

+ TeamID *string

+ TeamName *string

+ type PullSecretsResponse struct

+ Content string

+ type PushSecretsResponse struct

+ Message string

+ Stats ...

+ Success bool

+ type RepoIds struct

+ OwnerID int

+ RepoID int

+ func GetRepoIdsFromGitHub(ctx context.Context, owner, repo string) (*RepoIds, error)

+ type StartTrialResponse struct

+ Message string

+ TrialEnds string

+ type SyncDiff struct

+ Different []string

+ KeywayCount int

+ OnlyInKeyway []string

+ OnlyInProvider []string

+ ProviderCount int

+ Same []string

+ type SyncOptions struct

+ AllowDelete bool

+ ConnectionID string

+ Direction string

+ KeywayEnvironment string

+ ProjectID string

+ ProviderEnvironment string

+ ServiceID *string

+ type SyncPreview struct

+ ToCreate []string

+ ToDelete []string

+ ToSkip []string

+ ToUpdate []string

+ type SyncResult struct

+ Error string

+ Stats struct{ ... }

+ Success bool

+ type SyncStatus struct

+ IsFirstSync bool

+ ProviderHasSecrets bool

+ ProviderSecretCount int

+ VaultIsEmpty bool

+ type TrialEligibility struct

+ DaysAvailable int

+ Eligible bool

+ OrgLogin string

+ Reason string

+ type TrialInfo struct

+ DaysRemaining *int

+ EndsAt *string

+ Status string

+ TrialDurationDays int

+ type ValidateTokenResponse struct

+ GitHubID interface{}

+ Login string

+ Username string

+ type VaultInfo struct

+ Environments []string

+ ID string

+ RepoFullName string

v0.3.9

Dec 23, 2025

v0.3.8

Dec 23, 2025

v0.3.7

Dec 23, 2025

v0.3.6

Dec 23, 2025

v0.3.5

Dec 23, 2025

v0.3.4

Dec 22, 2025

v0.3.3

Dec 22, 2025

v0.3.2

Dec 22, 2025

v0.3.1

Dec 22, 2025

v0.3.0

Dec 22, 2025

v0.2.0

Dec 20, 2025

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