scalr

type AccessPolicies interface {
	List(ctx context.Context, options AccessPolicyListOptions) (*AccessPolicyList, error)
	Read(ctx context.Context, accessPolicyID string) (*AccessPolicy, error)
	Create(ctx context.Context, options AccessPolicyCreateOptions) (*AccessPolicy, error)
	Update(ctx context.Context, accessPolicyID string, options AccessPolicyUpdateOptions) (*AccessPolicy, error)
	Delete(ctx context.Context, accessPolicyID string) error
}

type AccessPolicy struct {
	ID             string          `jsonapi:"primary,access-policies"`
	IsSystem       bool            `jsonapi:"attr,is-system"`
	Roles          []*Role         `jsonapi:"relation,roles"`
	User           *User           `jsonapi:"relation,user,omitempty"`
	Team           *Team           `jsonapi:"relation,team,omitempty"`
	ServiceAccount *ServiceAccount `jsonapi:"relation,service-account,omitempty"`
	Account        *Account        `jsonapi:"relation,account,omitempty"`
	Environment    *Environment    `jsonapi:"relation,environment,omitempty"`
	Workspace      *Workspace      `jsonapi:"relation,workspace,omitempty"`
}

type AccessPolicyCreateOptions struct {
	ID string `jsonapi:"primary,access-policies"`

	// Relations
	Roles []*Role `jsonapi:"relation,roles"`
	// The subject of access policy, one of this fields must be filled
	User           *User           `jsonapi:"relation,user,omitempty"`
	Team           *Team           `jsonapi:"relation,team,omitempty"`
	ServiceAccount *ServiceAccount `jsonapi:"relation,service-account,omitempty"`
	// Scope
	Account     *Account     `jsonapi:"relation,account,omitempty"`
	Environment *Environment `jsonapi:"relation,environment,omitempty"`
	Workspace   *Workspace   `jsonapi:"relation,workspace,omitempty"`
}

type AccessPolicyList struct {
	*Pagination
	Items []*AccessPolicy
}

type AccessPolicyListOptions struct {
	ListOptions

	Environment    *string `url:"filter[environment],omitempty"`
	Account        *string `url:"filter[account],omitempty"`
	Workspace      *string `url:"filter[workspace],omitempty"`
	User           *string `url:"filter[user],omitempty"`
	ServiceAccount *string `url:"filter[service-account],omitempty"`
	Team           *string `url:"filter[team],omitempty"`
	Include        string  `url:"include,omitempty"`
}

type AccessPolicyUpdateOptions struct {
	// For internal use only!
	ID    string  `jsonapi:"primary,access-policies"`
	Roles []*Role `jsonapi:"relation,roles"`
}

type AccessToken struct {
	ID          string    `jsonapi:"primary,access-tokens"`
	CreatedAt   time.Time `jsonapi:"attr,created-at,iso8601"`
	Description string    `jsonapi:"attr,description"`
	Token       string    `jsonapi:"attr,token"`
}

type AccessTokenCreateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,access-tokens"`

	Description *string `jsonapi:"attr,description,omitempty"`
}

type AccessTokenList struct {
	*Pagination
	Items []*AccessToken
}

type AccessTokenListOptions struct {
	ListOptions
}

type AccessTokenUpdateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,access-tokens"`

	Description *string `jsonapi:"attr,description,omitempty"`
}

type AccessTokens interface {
	Read(ctx context.Context, accessTokenID string) (*AccessToken, error)
	Update(ctx context.Context, accessTokenID string, options AccessTokenUpdateOptions) (*AccessToken, error)
	Delete(ctx context.Context, accessTokenID string) error
}

type Account struct {
	ID         string   `jsonapi:"primary,accounts"`
	Name       string   `jsonapi:"attr,name"`
	AllowedIPs []string `jsonapi:"attr,allowed-ips"`
}

type AccountUpdateOptions struct {
	ID         string    `jsonapi:"primary,accounts"`
	AllowedIPs *[]string `jsonapi:"attr,allowed-ips,omitempty"`
}

type AccountUser struct {
	ID     string            `jsonapi:"primary,account-users"`
	Status AccountUserStatus `jsonapi:"attr,status"`

	// Relations
	Account *Account `jsonapi:"relation,account"`
	User    *User    `jsonapi:"relation,user"`
	Teams   []*Team  `jsonapi:"relation,teams"`
}

type AccountUserList struct {
	*Pagination
	Items []*AccountUser
}

type AccountUserListOptions struct {
	Account *string `url:"filter[account],omitempty"`
	User    *string `url:"filter[user],omitempty"`
	Query   *string `url:"query,omitempty"`
	Sort    *string `url:"sort,omitempty"`
	Include *string `url:"include,omitempty"`
}

type AccountUserStatus string

type AccountUsers interface {
	List(ctx context.Context, options AccountUserListOptions) (*AccountUserList, error)
}

type Accounts interface {
	Read(ctx context.Context, account string) (*Account, error)
	Update(ctx context.Context, account string, options AccountUpdateOptions) (*Account, error)
}

type Agent struct {
	ID   string `jsonapi:"primary,agents"`
	Name string `jsonapi:"attr,name"`
	OS   string `jsonapi:"attr,os"`
}

type AgentPool struct {
	ID         string `jsonapi:"primary,agent-pools"`
	Name       string `jsonapi:"attr,name"`
	VcsEnabled bool   `jsonapi:"attr,vcs-enabled"`

	// The agent pool's scope
	Account     *Account     `jsonapi:"relation,account"`
	Environment *Environment `jsonapi:"relation,environment"`

	// Workspaces this pool is connected to
	Workspaces []*Workspace `jsonapi:"relation,workspaces"`
	// Connected agents
	Agents []*Agent `jsonapi:"relation,agents"`
}

type AgentPoolCreateOptions struct {
	ID         string  `jsonapi:"primary,agent-pools"`
	Name       *string `jsonapi:"attr,name"`
	VcsEnabled *bool   `jsonapi:"attr,vcs-enabled,omitempty"`

	// The agent pool's scope
	Account     *Account     `jsonapi:"relation,account"`
	Environment *Environment `jsonapi:"relation,environment,omitempty"`

	// Workspaces this pool is connected to
	Workspaces []*Workspace `jsonapi:"relation,workspaces,omitempty"`
}

type AgentPoolList struct {
	*Pagination
	Items []*AgentPool
}

type AgentPoolListOptions struct {
	ListOptions

	Account     *string `url:"filter[account],omitempty"`
	Environment *string `url:"filter[environment],omitempty"`
	Name        string  `url:"filter[name],omitempty"`
	AgentPool   string  `url:"filter[agent-pool],omitempty"`
	VcsEnabled  *bool   `url:"filter[vcs-enabled],omitempty"`
	Include     string  `url:"include,omitempty"`
}

type AgentPoolTokens interface {
	List(ctx context.Context, agentPoolID string, options AccessTokenListOptions) (*AccessTokenList, error)
	Create(ctx context.Context, agentPoolID string, options AccessTokenCreateOptions) (*AccessToken, error)
}

type AgentPoolUpdateOptions struct {
	ID   string  `jsonapi:"primary,agent-pools"`
	Name *string `jsonapi:"attr,name,omitempty"`

	// Workspaces this pool is connected to
	Workspaces []*Workspace `jsonapi:"relation,workspaces"`
}

type AgentPools interface {
	List(ctx context.Context, options AgentPoolListOptions) (*AgentPoolList, error)
	Read(ctx context.Context, agentPoolID string) (*AgentPool, error)
	Create(ctx context.Context, options AgentPoolCreateOptions) (*AgentPool, error)
	Update(ctx context.Context, agentPoolID string, options AgentPoolUpdateOptions) (*AgentPool, error)
	Delete(ctx context.Context, agentPoolID string) error
}

type Apply struct {
	ID string `jsonapi:"primary,applies"`
}

type AuthType string

type CategoryType string

type Client struct {
	AccessPolicies                  AccessPolicies
	AccessTokens                    AccessTokens
	AccountUsers                    AccountUsers
	Accounts                        Accounts
	AgentPoolTokens                 AgentPoolTokens
	AgentPools                      AgentPools
	ConfigurationVersions           ConfigurationVersions
	Endpoints                       Endpoints
	EnvironmentTags                 EnvironmentTags
	Environments                    Environments
	ModuleVersions                  ModuleVersions
	Modules                         Modules
	PolicyGroupEnvironments         PolicyGroupEnvironments
	PolicyGroups                    PolicyGroups
	ProviderConfigurationLinks      ProviderConfigurationLinks
	ProviderConfigurationParameters ProviderConfigurationParameters
	ProviderConfigurations          ProviderConfigurations
	Roles                           Roles
	RunTriggers                     RunTriggers
	Runs                            Runs
	ServiceAccountTokens            ServiceAccountTokens
	ServiceAccounts                 ServiceAccounts
	SlackIntegrations               SlackIntegrations
	Tags                            Tags
	Teams                           Teams
	Users                           Users
	Variables                       Variables
	VcsProviders                    VcsProviders
	VcsRevisions                    VcsRevisions
	Webhooks                        Webhooks
	WebhookIntegrations             WebhookIntegrations
	WorkspaceTags                   WorkspaceTags
	Workspaces                      Workspaces
	// contains filtered or unexported fields
}

type Config struct {
	// The address of the Scalr API.
	Address string

	// The base path on which the API is served.
	BasePath string

	// API token used to access the Scalr API.
	Token string

	// Headers that will be added to every request.
	Headers http.Header

	// A custom HTTP client to use.
	HTTPClient *http.Client

	// RetryLogHook is invoked each time a request is retried.
	RetryLogHook RetryLogHook
}

type ConfigurationStatus string

type ConfigurationVersion struct {
	ID     string              `jsonapi:"primary,configuration-versions"`
	Status ConfigurationStatus `jsonapi:"attr,status"`
	// Relations
	Workspace *Workspace `jsonapi:"relation,workspace"`
}

type ConfigurationVersionCreateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,configuration-versions"`

	Workspace *Workspace `jsonapi:"relation,workspace"`
}

type ConfigurationVersions interface {
	// Create is used to create a new configuration version. The created
	// configuration version will be usable once data is uploaded to it.
	Create(ctx context.Context, options ConfigurationVersionCreateOptions) (*ConfigurationVersion, error)

	// Read a configuration version by its ID.
	Read(ctx context.Context, cvID string) (*ConfigurationVersion, error)
}

type CostEstimate struct {
	ID string `jsonapi:"primary,cost-estimates"`
}

type Downstream struct {
	ID string `jsonapi:"primary,workspaces"`
}

type Endpoint struct {
	ID          string `jsonapi:"primary,endpoints"`
	MaxAttempts int    `jsonapi:"attr,max-attempts"`
	Name        string `jsonapi:"attr,name"`
	SecretKey   string `jsonapi:"attr,secret-key"`
	Timeout     int    `jsonapi:"attr,timeout"`
	Url         string `jsonapi:"attr,url"`

	// Relations
	Environment *Environment `jsonapi:"relation,environment"`
	Account     *Account     `jsonapi:"relation,account"`
}

type EndpointCreateOptions struct {
	// For internal use only!
	ID          string  `jsonapi:"primary,endpoints"`
	MaxAttempts *int    `jsonapi:"attr,max-attempts,omitempty"`
	Name        *string `jsonapi:"attr,name"`
	Url         *string `jsonapi:"attr,url"`
	SecretKey   *string `jsonapi:"attr,secret-key,omitempty"`
	Timeout     *int    `jsonapi:"attr,timeout,omitempty"`

	// Relations
	Environment *Environment `jsonapi:"relation,environment,omitempty"`
	Account     *Account     `jsonapi:"relation,account"`
}

type EndpointList struct {
	*Pagination
	Items []*Endpoint
}

type EndpointListOptions struct {
	ListOptions

	// Query string.
	Query *string `url:"query,omitempty"`

	Name *string `url:"query,omitempty"`

	// The comma-separated list of attributes.
	Sort *string `url:"sort,omitempty"`

	// Scope filters.
	Environment *string `url:"filter[environment],omitempty"`
	Account     *string `url:"filter[account],omitempty"`
}

type EndpointUpdateOptions struct {
	ID          string  `jsonapi:"primary,endpoints"`
	Name        *string `jsonapi:"attr,name,omitempty"`
	MaxAttempts *int    `jsonapi:"attr,max-attempts,omitempty"`
	Url         *string `jsonapi:"attr,url,omitempty"`
	SecretKey   *string `jsonapi:"attr,secret-key,omitempty"`
	Timeout     *int    `jsonapi:"attr,timeout,omitempty"`
}

type Endpoints interface {
	// List the endpoints.
	List(ctx context.Context, options EndpointListOptions) (*EndpointList, error)
	Create(ctx context.Context, options EndpointCreateOptions) (*Endpoint, error)
	Read(ctx context.Context, endpoint string) (*Endpoint, error)
	Update(ctx context.Context, endpoint string, options EndpointUpdateOptions) (*Endpoint, error)
	Delete(ctx context.Context, endpoint string) error
}

type Environment struct {
	ID                    string            `jsonapi:"primary,environments"`
	Name                  string            `jsonapi:"attr,name"`
	CostEstimationEnabled bool              `jsonapi:"attr,cost-estimation-enabled"`
	CreatedAt             time.Time         `jsonapi:"attr,created-at,iso8601"`
	Status                EnvironmentStatus `jsonapi:"attr,status"`

	// Relations
	Account                       *Account                 `jsonapi:"relation,account"`
	PolicyGroups                  []*PolicyGroup           `jsonapi:"relation,policy-groups"`
	DefaultProviderConfigurations []*ProviderConfiguration `jsonapi:"relation,default-provider-configurations"`
	ProviderConfigurations        []*ProviderConfiguration `jsonapi:"relation,provider-configurations"`
	CreatedBy                     *User                    `jsonapi:"relation,created-by"`
	Tags                          []*Tag                   `jsonapi:"relation,tags"`
}

type EnvironmentCreateOptions struct {
	ID                    string  `jsonapi:"primary,environments"`
	Name                  *string `jsonapi:"attr,name"`
	CostEstimationEnabled *bool   `jsonapi:"attr,cost-estimation-enabled,omitempty"`

	// Relations
	Account                       *Account                 `jsonapi:"relation,account"`
	PolicyGroups                  []*PolicyGroup           `jsonapi:"relation,policy-groups,omitempty"`
	DefaultProviderConfigurations []*ProviderConfiguration `jsonapi:"relation,default-provider-configurations,omitempty"`

	// Specifies tags assigned to the environment
	Tags []*Tag `jsonapi:"relation,tags,omitempty"`
}

type EnvironmentFilter struct {
	Id      *string `url:"environment,omitempty"`
	Account *string `url:"account,omitempty"`
	Name    *string `url:"name,omitempty"`
	Tag     *string `url:"tag,omitempty"`
}

type EnvironmentList struct {
	*Pagination
	Items []*Environment
}

type EnvironmentListOptions struct {
	ListOptions

	Include *string            `url:"include,omitempty"`
	Filter  *EnvironmentFilter `url:"filter,omitempty"`
}

type EnvironmentStatus string

type EnvironmentTags interface {
	Add(ctx context.Context, envID string, tags []*TagRelation) error
	Replace(ctx context.Context, envID string, tags []*TagRelation) error
	Delete(ctx context.Context, envID string, tags []*TagRelation) error
}

type EnvironmentUpdateOptions struct {
	// For internal use only!
	ID                    string  `jsonapi:"primary,environments"`
	Name                  *string `jsonapi:"attr,name,omitempty"`
	CostEstimationEnabled *bool   `jsonapi:"attr,cost-estimation-enabled,omitempty"`

	// Relations
	PolicyGroups                  []*PolicyGroup           `jsonapi:"relation,policy-groups"`
	DefaultProviderConfigurations []*ProviderConfiguration `jsonapi:"relation,default-provider-configurations"`
}

type EnvironmentUpdateOptionsDefaultProviderConfigurationOnly struct {
	ID string `jsonapi:"primary,environments"`
	// Relations
	DefaultProviderConfigurations []*ProviderConfiguration `jsonapi:"relation,default-provider-configurations"`
}

type Environments interface {
	List(ctx context.Context, options EnvironmentListOptions) (*EnvironmentList, error)
	Read(ctx context.Context, environmentID string) (*Environment, error)
	Create(ctx context.Context, options EnvironmentCreateOptions) (*Environment, error)
	Update(ctx context.Context, environmentID string, options EnvironmentUpdateOptions) (*Environment, error)
	UpdateDefaultProviderConfigurationOnly(ctx context.Context, environmentID string, options EnvironmentUpdateOptionsDefaultProviderConfigurationOnly) (*Environment, error)
	Delete(ctx context.Context, environmentID string) error
}

type EventDefinition struct {
	ID string `jsonapi:"primary,event-definitions"`
}

type Hooks struct {
	PreInit   string `json:"pre-init"`
	PrePlan   string `json:"pre-plan"`
	PostPlan  string `json:"post-plan"`
	PreApply  string `json:"pre-apply"`
	PostApply string `json:"post-apply"`
}

type HooksOptions struct {
	PreInit   *string `json:"pre-init,omitempty"`
	PrePlan   *string `json:"pre-plan,omitempty"`
	PostPlan  *string `json:"post-plan,omitempty"`
	PreApply  *string `json:"pre-apply,omitempty"`
	PostApply *string `json:"post-apply,omitempty"`
}

type IdentityProvider struct {
	ID string `jsonapi:"primary,identity-providers"`
}

type IntegrationStatus string

type ListOptions struct {
	// The page number to request. The results vary based on the PageSize.
	PageNumber int `url:"page[number],omitempty"`

	// The number of elements returned in a single page.
	PageSize int `url:"page[size],omitempty"`
}

type Module struct {
	ID          string         `jsonapi:"primary,modules"`
	CreatedAt   time.Time      `jsonapi:"attr,created-at,iso8601"`
	Name        string         `jsonapi:"attr,name"`
	Provider    string         `jsonapi:"attr,provider"`
	Source      string         `jsonapi:"attr,source"`
	Description *string        `jsonapi:"attr,description,omitempty"`
	VCSRepo     *ModuleVCSRepo `jsonapi:"attr,vcs-repo"`
	Status      ModuleStatus   `jsonapi:"attr,status"`
	// Relation
	VcsProvider         *VcsProvider   `jsonapi:"relation,vcs-provider"`
	Account             *Account       `jsonapi:"relation,account,omitempty"`
	Environment         *Environment   `jsonapi:"relation,environment,omitempty"`
	CreatedBy           *User          `jsonapi:"relation,created-by,omitempty"`
	LatestModuleVersion *ModuleVersion `jsonapi:"relation,latest-module-version,omitempty"`
	ModuleVersion       *ModuleVersion `jsonapi:"relation,module-version,omitempty"`
}

type ModuleCreateOptions struct {
	//// For internal use only!
	ID string `jsonapi:"primary,modules"`

	// Settings for the module VCS repository.
	VCSRepo *ModuleVCSRepo `jsonapi:"attr,vcs-repo"`

	// Specifies the VcsProvider for module vcs-repo.
	VcsProvider *VcsProvider `jsonapi:"relation,vcs-provider"`

	// Specifies the Account for module
	Account *Account `jsonapi:"relation,account,omitempty"`

	// Specifies the Environment for module
	Environment *Environment `jsonapi:"relation,environment,omitempty"`
}

type ModuleList struct {
	*Pagination
	Items []*Module
}

type ModuleListOptions struct {
	ListOptions
	Name        *string       `url:"filter[name],omitempty"`
	Status      *ModuleStatus `url:"filter[status],omitempty"`
	Source      *string       `url:"filter[source],omitempty"`
	Provider    *string       `url:"filter[provider],omitempty"`
	Account     *string       `url:"filter[account],omitempty"`
	Environment *string       `url:"filter[environment],omitempty"`
}

type ModuleStatus string

type ModuleVCSRepo struct {
	Identifier string  `json:"identifier"`
	Path       *string `json:"path"`
	TagPrefix  *string `json:"tag-prefix,omitempty"`
}

type ModuleVersion struct {
	ID           string              `jsonapi:"primary,module-versions"`
	IsRootModule bool                `jsonapi:"attr,is-root-module"`
	Status       ModuleVersionStatus `jsonapi:"attr,status"`
	Version      string              `jsonapi:"attr,version"`
}

type ModuleVersionList struct {
	*Pagination
	Items []*ModuleVersion
}

type ModuleVersionListOptions struct {
	ListOptions
	Module  string  `url:"filter[module]"`
	Status  *string `url:"filter[status],omitempty"`
	Version *string `url:"filter[version],omitempty"`
	Include string  `url:"include,omitempty"`
}

type ModuleVersionStatus string

type ModuleVersions interface {
	// List all the module versions within a module.
	List(ctx context.Context, options ModuleVersionListOptions) (*ModuleVersionList, error)
	// Read a module version by its ID.
	Read(ctx context.Context, moduleVersionID string) (*ModuleVersion, error)
}

type Modules interface {
	// List all the modules .
	List(ctx context.Context, options ModuleListOptions) (*ModuleList, error)
	// Create the module
	Create(ctx context.Context, options ModuleCreateOptions) (*Module, error)
	// Read a module by its ID.
	Read(ctx context.Context, moduleID string) (*Module, error)
	// ReadBySource Read the module by its Source.
	ReadBySource(ctx context.Context, moduleSource string) (*Module, error)
	// Delete a module by its ID.
	Delete(ctx context.Context, moduleID string) error
}

type OAuth struct {
	ClientId     string `json:"client-id"`
	ClientSecret string `json:"client-secret"`
}

type Organization struct {
	ID                    string            `jsonapi:"primary,organizations"`
	Name                  string            `jsonapi:"attr,name"`
	CostEstimationEnabled bool              `jsonapi:"attr,cost-estimation-enabled"`
	CreatedAt             time.Time         `jsonapi:"attr,created-at,iso8601"`
	CreatedBy             string            `jsonapi:"attr,created-by"`
	Status                EnvironmentStatus `jsonapi:"attr,status"`

	// Relations
	Account *Account `jsonapi:"relation,account"`
}

type Pagination struct {
	CurrentPage  int `json:"current-page"`
	PreviousPage int `json:"prev-page"`
	NextPage     int `json:"next-page"`
	TotalPages   int `json:"total-pages"`
	TotalCount   int `json:"total-count"`
}

type Permission struct {
	ID string `jsonapi:"primary,permissions,omitempty"`
}

type Plan struct {
	ID string `jsonapi:"primary,plans"`
}

type Policy struct {
	ID               string                 `jsonapi:"primary,policies"`
	Name             string                 `jsonapi:"attr,name"`
	Enabled          bool                   `jsonapi:"attr,enabled"`
	EnforcementLevel PolicyEnforcementLevel `jsonapi:"attr,enforced-level"`

	// Relations
	PolicyGroup *PolicyGroup `jsonapi:"relation,policy-groups"`
}

type PolicyCheck struct {
	ID string `jsonapi:"primary,policy-checks"`
}

type PolicyEnforcementLevel string

type PolicyGroup struct {
	ID           string              `jsonapi:"primary,policy-groups"`
	Name         string              `jsonapi:"attr,name"`
	Status       PolicyGroupStatus   `jsonapi:"attr,status"`
	ErrorMessage string              `jsonapi:"attr,error-message"`
	OpaVersion   string              `jsonapi:"attr,opa-version"`
	VCSRepo      *PolicyGroupVCSRepo `jsonapi:"attr,vcs-repo"`

	// Relations
	Account      *Account       `jsonapi:"relation,account"`
	VcsProvider  *VcsProvider   `jsonapi:"relation,vcs-provider"`
	VcsRevision  *VcsRevision   `jsonapi:"relation,vcs-revision"`
	Policies     []*Policy      `jsonapi:"relation,policies"`
	Environments []*Environment `jsonapi:"relation,environments"`
}

type PolicyGroupCreateOptions struct {
	ID         string                     `jsonapi:"primary,policy-groups"`
	Name       *string                    `jsonapi:"attr,name"`
	OpaVersion *string                    `jsonapi:"attr,opa-version,omitempty"`
	VCSRepo    *PolicyGroupVCSRepoOptions `jsonapi:"attr,vcs-repo"`

	// Relations
	Account     *Account     `jsonapi:"relation,account"`
	VcsProvider *VcsProvider `jsonapi:"relation,vcs-provider"`
}

type PolicyGroupEnvironment struct {
	ID string `jsonapi:"primary,environments"`
}

type PolicyGroupEnvironmentDeleteOptions struct {
	PolicyGroupID string
	EnvironmentID string
}

type PolicyGroupEnvironments interface {
	Create(ctx context.Context, options PolicyGroupEnvironmentsCreateOptions) error
	Delete(ctx context.Context, options PolicyGroupEnvironmentDeleteOptions) error
}

type PolicyGroupEnvironmentsCreateOptions struct {
	PolicyGroupID           string
	PolicyGroupEnvironments []*PolicyGroupEnvironment
}

type PolicyGroupList struct {
	*Pagination
	Items []*PolicyGroup
}

type PolicyGroupListOptions struct {
	ListOptions

	Account     string `url:"filter[account],omitempty"`
	Environment string `url:"filter[environment],omitempty"`
	Name        string `url:"filter[name],omitempty"`
	PolicyGroup string `url:"filter[policy-group],omitempty"`
	Query       string `url:"query,omitempty"`
	Sort        string `url:"sort,omitempty"`
	Include     string `url:"include,omitempty"`
}

type PolicyGroupStatus string

type PolicyGroupUpdateOptions struct {
	ID         string                     `jsonapi:"primary,policy-groups"`
	Name       *string                    `jsonapi:"attr,name,omitempty"`
	OpaVersion *string                    `jsonapi:"attr,opa-version,omitempty"`
	VCSRepo    *PolicyGroupVCSRepoOptions `jsonapi:"attr,vcs-repo,omitempty"`

	// Relations
	VcsProvider *VcsProvider `jsonapi:"relation,vcs-provider,omitempty"`
}

type PolicyGroupVCSRepo struct {
	Identifier string `json:"identifier"`
	Branch     string `json:"branch"`
	Path       string `json:"path"`
}

type PolicyGroupVCSRepoOptions struct {
	Identifier *string `json:"identifier"`
	Branch     *string `json:"branch,omitempty"`
	Path       *string `json:"path,omitempty"`
}

type PolicyGroups interface {
	List(ctx context.Context, options PolicyGroupListOptions) (*PolicyGroupList, error)
	Read(ctx context.Context, policyGroupID string) (*PolicyGroup, error)
	Create(ctx context.Context, options PolicyGroupCreateOptions) (*PolicyGroup, error)
	Update(ctx context.Context, policyGroupID string, options PolicyGroupUpdateOptions) (*PolicyGroup, error)
	Delete(ctx context.Context, policyGroupID string) error
}

type ProviderConfiguration struct {
	ID                         string `jsonapi:"primary,provider-configurations"`
	Name                       string `jsonapi:"attr,name"`
	ProviderName               string `jsonapi:"attr,provider-name"`
	ExportShellVariables       bool   `jsonapi:"attr,export-shell-variables"`
	IsShared                   bool   `jsonapi:"attr,is-shared"`
	IsCustom                   bool   `jsonapi:"attr,is-custom"`
	AwsAccessKey               string `jsonapi:"attr,aws-access-key"`
	AwsSecretKey               string `jsonapi:"attr,aws-secret-key"`
	AwsAccountType             string `jsonapi:"attr,aws-account-type"`
	AwsCredentialsType         string `jsonapi:"attr,aws-credentials-type"`
	AwsTrustedEntityType       string `jsonapi:"attr,aws-trusted-entity-type"`
	AwsRoleArn                 string `jsonapi:"attr,aws-role-arn"`
	AwsExternalId              string `jsonapi:"attr,aws-external-id"`
	AwsAudience                string `jsonapi:"attr,aws-audience"`
	AzurermClientId            string `jsonapi:"attr,azurerm-client-id"`
	AzurermClientSecret        string `jsonapi:"attr,azurerm-client-secret"`
	AzurermSubscriptionId      string `jsonapi:"attr,azurerm-subscription-id"`
	AzurermTenantId            string `jsonapi:"attr,azurerm-tenant-id"`
	AzurermAuthType            string `jsonapi:"attr,azurerm-auth-type"`
	AzurermAudience            string `jsonapi:"attr,azurerm-audience"`
	GoogleAuthType             string `jsonapi:"attr,google-auth-type"`
	GoogleServiceAccountEmail  string `jsonapi:"attr,google-service-account-email"`
	GoogleWorkloadProviderName string `jsonapi:"attr,google-workload-provider-name"`
	GoogleProject              string `jsonapi:"attr,google-project"`
	GoogleCredentials          string `jsonapi:"attr,google-credentials"`
	ScalrHostname              string `jsonapi:"attr,scalr-hostname"`
	ScalrToken                 string `jsonapi:"attr,scalr-token"`

	Account      *Account                          `jsonapi:"relation,account"`
	Parameters   []*ProviderConfigurationParameter `jsonapi:"relation,parameters"`
	Environments []*Environment                    `jsonapi:"relation,environments"`
}

type ProviderConfigurationCreateOptions struct {
	ID                         string  `jsonapi:"primary,provider-configurations"`
	Name                       *string `jsonapi:"attr,name"`
	ProviderName               *string `jsonapi:"attr,provider-name"`
	ExportShellVariables       *bool   `jsonapi:"attr,export-shell-variables,omitempty"`
	IsShared                   *bool   `jsonapi:"attr,is-shared,omitempty"`
	IsCustom                   *bool   `jsonapi:"attr,is-custom,omitempty"`
	AwsAccessKey               *string `jsonapi:"attr,aws-access-key,omitempty"`
	AwsSecretKey               *string `jsonapi:"attr,aws-secret-key,omitempty"`
	AwsAccountType             *string `jsonapi:"attr,aws-account-type"`
	AwsCredentialsType         *string `jsonapi:"attr,aws-credentials-type"`
	AwsTrustedEntityType       *string `jsonapi:"attr,aws-trusted-entity-type"`
	AwsAudience                *string `jsonapi:"attr,aws-audience"`
	AwsRoleArn                 *string `jsonapi:"attr,aws-role-arn"`
	AwsExternalId              *string `jsonapi:"attr,aws-external-id"`
	AzurermClientId            *string `jsonapi:"attr,azurerm-client-id,omitempty"`
	AzurermClientSecret        *string `jsonapi:"attr,azurerm-client-secret,omitempty"`
	AzurermSubscriptionId      *string `jsonapi:"attr,azurerm-subscription-id,omitempty"`
	AzurermTenantId            *string `jsonapi:"attr,azurerm-tenant-id,omitempty"`
	AzurermAuthType            *string `jsonapi:"attr,azurerm-auth-type,omitempty"`
	AzurermAudience            *string `jsonapi:"attr,azurerm-audience,omitempty"`
	GoogleAuthType             *string `jsonapi:"attr,google-auth-type,omitempty"`
	GoogleServiceAccountEmail  *string `jsonapi:"attr,google-service-account-email,omitempty"`
	GoogleWorkloadProviderName *string `jsonapi:"attr,google-workload-provider-name,omitempty"`
	GoogleProject              *string `jsonapi:"attr,google-project,omitempty"`
	GoogleCredentials          *string `jsonapi:"attr,google-credentials,omitempty"`
	ScalrHostname              *string `jsonapi:"attr,scalr-hostname,omitempty"`
	ScalrToken                 *string `jsonapi:"attr,scalr-token,omitempty"`

	Account      *Account       `jsonapi:"relation,account,omitempty"`
	Environments []*Environment `jsonapi:"relation,environments,omitempty"`
}

type ProviderConfigurationFilter struct {
	ProviderConfiguration string `url:"provider-configuration,omitempty"`
	ProviderName          string `url:"provider-name,omitempty"`
	Name                  string `url:"name,omitempty"`
	AccountID             string `url:"account,omitempty"`
}

type ProviderConfigurationLink struct {
	ID      string `jsonapi:"primary,provider-configuration-links"`
	Default bool   `jsonapi:"attr,default"`
	Alias   string `jsonapi:"attr,alias"`

	ProviderConfiguration *ProviderConfiguration `jsonapi:"relation,provider-configuration,omitempty"`
	Environment           *Environment           `jsonapi:"relation,environment,omitempty"`
	Workspace             *Workspace             `jsonapi:"relation,workspace,omitempty"`
}

type ProviderConfigurationLinkCreateOptions struct {
	ID    string  `jsonapi:"primary,provider-configuration-links"`
	Alias *string `jsonapi:"attr,alias"`

	ProviderConfiguration *ProviderConfiguration `jsonapi:"relation,provider-configuration"`
}

type ProviderConfigurationLinkUpdateOptions struct {
	ID    string  `jsonapi:"primary,provider-configuration-links"`
	Alias *string `jsonapi:"attr,alias"`
}

type ProviderConfigurationLinks interface {
	List(ctx context.Context, workspaceID string, options ProviderConfigurationLinksListOptions) (*ProviderConfigurationLinksList, error)
	Create(ctx context.Context, workspaceID string, options ProviderConfigurationLinkCreateOptions) (*ProviderConfigurationLink, error)
	Read(ctx context.Context, linkID string) (*ProviderConfigurationLink, error)
	Delete(ctx context.Context, linkID string) error
	Update(ctx context.Context, linkID string, options ProviderConfigurationLinkUpdateOptions) (*ProviderConfigurationLink, error)
}

type ProviderConfigurationLinksList struct {
	*Pagination
	Items []*ProviderConfigurationLink
}

type ProviderConfigurationLinksListOptions struct {
	ListOptions

	Include string `url:"include,omitempty"`
}

type ProviderConfigurationParameter struct {
	ID          string `jsonapi:"primary,provider-configuration-parameters"`
	Key         string `jsonapi:"attr,key"`
	Sensitive   bool   `jsonapi:"attr,sensitive"`
	Value       string `jsonapi:"attr,value"`
	Description string `jsonapi:"attr,description"`
}

type ProviderConfigurationParameterCreateOptions struct {
	ID          string  `jsonapi:"primary,provider-configuration-parameters"`
	Key         *string `jsonapi:"attr,key"`
	Sensitive   *bool   `jsonapi:"attr,sensitive,omitempty"`
	Value       *string `jsonapi:"attr,value"`
	Description *string `jsonapi:"attr,description,omitempty"`
}

type ProviderConfigurationParameterUpdateOptions struct {
	ID          string  `jsonapi:"primary,provider-configuration-parameters"`
	Key         *string `jsonapi:"attr,key,omitempty"`
	Sensitive   *bool   `jsonapi:"attr,sensitive,omitempty"`
	Value       *string `jsonapi:"attr,value,omitempty"`
	Description *string `jsonapi:"attr,description,omitempty"`
}

type ProviderConfigurationParameters interface {
	List(ctx context.Context, configurationID string, options ProviderConfigurationParametersListOptions) (*ProviderConfigurationParametersList, error)
	Create(ctx context.Context, configurationID string, options ProviderConfigurationParameterCreateOptions) (*ProviderConfigurationParameter, error)
	Read(ctx context.Context, parameterID string) (*ProviderConfigurationParameter, error)
	Delete(ctx context.Context, parameterID string) error
	Update(ctx context.Context, parameterID string, options ProviderConfigurationParameterUpdateOptions) (*ProviderConfigurationParameter, error)
}

type ProviderConfigurationParametersList struct {
	*Pagination
	Items []*ProviderConfigurationParameter
}

type ProviderConfigurationParametersListOptions struct {
	ListOptions

	Sort string `url:"sort,omitempty"`
}

type ProviderConfigurationUpdateOptions struct {
	ID string `jsonapi:"primary,provider-configurations"`

	Name                       *string        `jsonapi:"attr,name"`
	IsShared                   *bool          `jsonapi:"attr,is-shared,omitempty"`
	Environments               []*Environment `jsonapi:"relation,environments"`
	ExportShellVariables       *bool          `jsonapi:"attr,export-shell-variables"`
	AwsAccessKey               *string        `jsonapi:"attr,aws-access-key"`
	AwsSecretKey               *string        `jsonapi:"attr,aws-secret-key"`
	AwsAccountType             *string        `jsonapi:"attr,aws-account-type"`
	AwsCredentialsType         *string        `jsonapi:"attr,aws-credentials-type"`
	AwsTrustedEntityType       *string        `jsonapi:"attr,aws-trusted-entity-type"`
	AwsRoleArn                 *string        `jsonapi:"attr,aws-role-arn"`
	AwsExternalId              *string        `jsonapi:"attr,aws-external-id"`
	AwsAudience                *string        `jsonapi:"attr,aws-audience"`
	AzurermAuthType            *string        `jsonapi:"attr,azurerm-auth-type"`
	AzurermAudience            *string        `jsonapi:"attr,azurerm-audience"`
	AzurermClientId            *string        `jsonapi:"attr,azurerm-client-id"`
	AzurermClientSecret        *string        `jsonapi:"attr,azurerm-client-secret"`
	AzurermSubscriptionId      *string        `jsonapi:"attr,azurerm-subscription-id"`
	AzurermTenantId            *string        `jsonapi:"attr,azurerm-tenant-id"`
	GoogleAuthType             *string        `jsonapi:"attr,google-auth-type"`
	GoogleServiceAccountEmail  *string        `jsonapi:"attr,google-service-account-email"`
	GoogleWorkloadProviderName *string        `jsonapi:"attr,google-workload-provider-name"`
	GoogleProject              *string        `jsonapi:"attr,google-project"`
	GoogleCredentials          *string        `jsonapi:"attr,google-credentials"`
	ScalrHostname              *string        `jsonapi:"attr,scalr-hostname"`
	ScalrToken                 *string        `jsonapi:"attr,scalr-token"`
}

type ProviderConfigurations interface {
	List(ctx context.Context, options ProviderConfigurationsListOptions) (*ProviderConfigurationsList, error)
	Create(ctx context.Context, options ProviderConfigurationCreateOptions) (*ProviderConfiguration, error)
	Read(ctx context.Context, configurationID string) (*ProviderConfiguration, error)
	Delete(ctx context.Context, configurationID string) error
	Update(ctx context.Context, configurationID string, options ProviderConfigurationUpdateOptions) (*ProviderConfiguration, error)
}

type ProviderConfigurationsList struct {
	*Pagination
	Items []*ProviderConfiguration
}

type ProviderConfigurationsListOptions struct {
	ListOptions

	Sort    string                       `url:"sort,omitempty"`
	Include string                       `url:"include,omitempty"`
	Filter  *ProviderConfigurationFilter `url:"filter,omitempty"`
}

type ResourceNotFoundError struct {
	Message string
}

type RetryLogHook func(attemptNum int, resp *http.Response)

type Role struct {
	ID          string `jsonapi:"primary,roles"`
	Name        string `jsonapi:"attr,name"`
	Description string `jsonapi:"attr,description"`
	IsSystem    bool   `jsonapi:"attr,is-system"`

	// Relations
	Account     *Account      `jsonapi:"relation,account"`
	Permissions []*Permission `jsonapi:"relation,permissions,omitempty"`
}

type RoleCreateOptions struct {
	ID          string  `jsonapi:"primary,roles"`
	Name        *string `jsonapi:"attr,name"`
	Description *string `jsonapi:"attr,description,omitempty"`

	// Relations
	Account     *Account      `jsonapi:"relation,account"`
	Permissions []*Permission `jsonapi:"relation,permissions,omitempty"`
}

type RoleList struct {
	*Pagination
	Items []*Role
}

type RoleListOptions struct {
	ListOptions

	Account *string `url:"filter[account],omitempty"`
	Name    string  `url:"filter[name],omitempty"`
	Role    string  `url:"filter[role],omitempty"`
	Query   string  `url:"query,omitempty"`
	Include string  `url:"include,omitempty"`
}

type RoleUpdateOptions struct {
	// For internal use only!
	ID          string  `jsonapi:"primary,roles"`
	Name        *string `jsonapi:"attr,name,omitempty"`
	Description *string `jsonapi:"attr,description,omitempty"`

	// Relations
	Permissions []*Permission `jsonapi:"relation,permissions,omitempty"`
}

type Roles interface {
	List(ctx context.Context, options RoleListOptions) (*RoleList, error)
	Read(ctx context.Context, roleID string) (*Role, error)
	Create(ctx context.Context, options RoleCreateOptions) (*Role, error)
	Update(ctx context.Context, roleID string, options RoleUpdateOptions) (*Role, error)
	Delete(ctx context.Context, roleID string) error
}

type Run struct {
	ID        string    `jsonapi:"primary,runs"`
	Source    RunSource `jsonapi:"attr,source"`
	Message   string    `jsonapi:"attr,message"`
	IsDestroy bool      `jsonapi:"attr,is-destroy"`
	CreatedAt time.Time `jsonapi:"attr,created-at,iso8601"`
	Status    RunStatus `jsonapi:"attr,status"`

	// Relations
	VcsRevision          *VcsRevision          `jsonapi:"relation,vcs-revision"`
	Apply                *Apply                `jsonapi:"relation,apply"`
	ConfigurationVersion *ConfigurationVersion `jsonapi:"relation,configuration-version"`
	CostEstimate         *CostEstimate         `jsonapi:"relation,cost-estimate"`
	Plan                 *Plan                 `jsonapi:"relation,plan"`
	PolicyChecks         []*PolicyCheck        `jsonapi:"relation,policy-checks"`
	Workspace            *Workspace            `jsonapi:"relation,workspace"`
}

type RunCreateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,runs"`

	// Specifies the configuration version to use for this run.
	ConfigurationVersion *ConfigurationVersion `jsonapi:"relation,configuration-version"`
	// Specifies the workspace where the run will be executed.
	Workspace *Workspace `jsonapi:"relation,workspace"`
}

type RunSource string

type RunStatus string

type RunTrigger struct {
	ID        string    `jsonapi:"primary,run-triggers"`
	CreatedAt time.Time `jsonapi:"attr,created-at,iso8601"`

	// Relations
	Upstream   *Upstream   `jsonapi:"relation,upstream"`
	Downstream *Downstream `jsonapi:"relation,downstream"`
}

type RunTriggerCreateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,run-triggers"`

	Downstream *Downstream `jsonapi:"relation,downstream"`
	Upstream   *Upstream   `jsonapi:"relation,upstream"`
}

type RunTriggers interface {
	// Create is used to create a new run trigger.
	Create(ctx context.Context, options RunTriggerCreateOptions) (*RunTrigger, error)

	// Read RunTrigger by it's ID
	Read(ctx context.Context, runTriggerID string) (*RunTrigger, error)

	// Delete RunTrigger by it's ID
	Delete(ctx context.Context, runTriggerID string) error
}

type Runs interface {

	// Read a run by its ID.
	Read(ctx context.Context, runID string) (*Run, error)
	// Create a new run with the given options.
	Create(ctx context.Context, options RunCreateOptions) (*Run, error)
}

type ServiceAccount struct {
	ID          string               `jsonapi:"primary,service-accounts"`
	Name        string               `jsonapi:"attr,name"`
	Email       string               `jsonapi:"attr,email"`
	Description string               `jsonapi:"attr,description"`
	Status      ServiceAccountStatus `jsonapi:"attr,status"`
	CreatedAt   time.Time            `jsonapi:"attr,created-at,iso8601"`

	// Relations
	Account   *Account `jsonapi:"relation,account,omitempty"`
	CreatedBy *User    `jsonapi:"relation,created-by,omitempty"`
}

type ServiceAccountCreateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,service-accounts"`

	// The name of the service account, it must be unique within the account.
	Name        *string               `jsonapi:"attr,name"`
	Description *string               `jsonapi:"attr,description,omitempty"`
	Status      *ServiceAccountStatus `jsonapi:"attr,status,omitempty"`
	Account     *Account              `jsonapi:"relation,account"`
}

type ServiceAccountList struct {
	*Pagination
	Items []*ServiceAccount
}

type ServiceAccountListOptions struct {
	ListOptions

	Account        *string `url:"filter[account],omitempty"`
	Email          *string `url:"filter[email],omitempty"`
	ServiceAccount *string `url:"filter[service-account],omitempty"`
	Query          *string `url:"query,omitempty"`
	Include        *string `url:"include,omitempty"`
}

type ServiceAccountStatus string

type ServiceAccountTokens interface {
	// List service account's access tokens
	List(ctx context.Context, serviceAccountID string, options AccessTokenListOptions) (*AccessTokenList, error)
	// Create new access token for service account
	Create(ctx context.Context, serviceAccountID string, options AccessTokenCreateOptions) (*AccessToken, error)
}

type ServiceAccountUpdateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,service-accounts"`

	Description *string               `jsonapi:"attr,description,omitempty"`
	Status      *ServiceAccountStatus `jsonapi:"attr,status,omitempty"`
}

type ServiceAccounts interface {
	// List all the service accounts.
	List(ctx context.Context, options ServiceAccountListOptions) (*ServiceAccountList, error)
	// Create is used to create a new service account.
	Create(ctx context.Context, options ServiceAccountCreateOptions) (*ServiceAccount, error)
	// Read reads a service account by its ID.
	Read(ctx context.Context, serviceAccountID string) (*ServiceAccount, error)
	// Update existing service account by its ID.
	Update(ctx context.Context, serviceAccountID string, options ServiceAccountUpdateOptions) (*ServiceAccount, error)
	// Delete service account by its ID.
	Delete(ctx context.Context, serviceAccountID string) error
}

type SlackConnection struct {
	ID                 string `jsonapi:"primary,slack-connections"`
	SlackWorkspaceName string `jsonapi:"attr,slack-workspace-name"`

	// Relations
	Account *Account `jsonapi:"relation,account"`
}

type SlackIntegration struct {
	ID        string            `jsonapi:"primary,slack-integrations"`
	Name      string            `jsonapi:"attr,name"`
	Status    IntegrationStatus `jsonapi:"attr,status"`
	ChannelId string            `jsonapi:"attr,channel-id"`
	Events    []string          `jsonapi:"attr,events"`

	// Relations
	Account      *Account       `jsonapi:"relation,account"`
	Environments []*Environment `jsonapi:"relation,environments"`
	Workspaces   []*Workspace   `jsonapi:"relation,workspaces"`
}

type SlackIntegrationCreateOptions struct {
	ID        string   `jsonapi:"primary,slack-integrations"`
	Name      *string  `jsonapi:"attr,name"`
	ChannelId *string  `jsonapi:"attr,channel-id"`
	Events    []string `jsonapi:"attr,events"`

	Account      *Account         `jsonapi:"relation,account"`
	Connection   *SlackConnection `jsonapi:"relation,connection"`
	Environments []*Environment   `jsonapi:"relation,environments"`
	Workspaces   []*Workspace     `jsonapi:"relation,workspaces,omitempty"`
}

type SlackIntegrationFilter struct {
	Account *string `url:"account,omitempty"`
}

type SlackIntegrationList struct {
	*Pagination
	Items []*SlackIntegration
}

type SlackIntegrationListOptions struct {
	ListOptions

	Filter *SlackIntegrationFilter `url:"filter,omitempty"`
}

type SlackIntegrationUpdateOptions struct {
	ID        string             `jsonapi:"primary,slack-integrations"`
	Name      *string            `jsonapi:"attr,name,omitempty"`
	ChannelId *string            `jsonapi:"attr,channel-id,omitempty"`
	Status    *IntegrationStatus `jsonapi:"attr,status,omitempty"`
	Events    []string           `jsonapi:"attr,events,omitempty"`

	Environments []*Environment `jsonapi:"relation,environments,omitempty"`
	Workspaces   []*Workspace   `jsonapi:"relation,workspaces"`
}

type SlackIntegrations interface {
	List(ctx context.Context, options SlackIntegrationListOptions) (*SlackIntegrationList, error)
	Create(ctx context.Context, options SlackIntegrationCreateOptions) (*SlackIntegration, error)
	Read(ctx context.Context, slackIntegration string) (*SlackIntegration, error)
	Update(ctx context.Context, slackIntegration string, options SlackIntegrationUpdateOptions) (*SlackIntegration, error)
	Delete(ctx context.Context, slackIntegration string) error
	GetConnection(ctx context.Context, accID string) (*SlackConnection, error)
}

type Tag struct {
	ID   string `jsonapi:"primary,tags"`
	Name string `jsonapi:"attr,name"`

	// Relations
	Account *Account `jsonapi:"relation,account"`
}

type TagCreateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,tags"`
	// The name of the tag, it must be unique within the account.
	Name *string `jsonapi:"attr,name"`
	// Specifies the Account for the tag.
	Account *Account `jsonapi:"relation,account"`
}

type TagList struct {
	*Pagination
	Items []*Tag
}

type TagListOptions struct {
	ListOptions

	Tag     *string `url:"filter[tag],omitempty"`
	Account *string `url:"filter[account],omitempty"`
	Name    *string `url:"filter[name],omitempty"`
	Query   *string `url:"query,omitempty"`
}

type TagRelation struct {
	ID string `jsonapi:"primary,tags"`
}

type TagUpdateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,tags"`
	// The name of the tag, it must be unique within the account.
	Name *string `jsonapi:"attr,name"`
}

type Tags interface {
	// List all the tags.
	List(ctx context.Context, options TagListOptions) (*TagList, error)
	// Create is used to create a new tag.
	Create(ctx context.Context, options TagCreateOptions) (*Tag, error)
	// Read reads a tag by its ID.
	Read(ctx context.Context, tagID string) (*Tag, error)
	// Update existing tag by its ID.
	Update(ctx context.Context, tagID string, options TagUpdateOptions) (*Tag, error)
	// Delete deletes a tag by its ID.
	Delete(ctx context.Context, tagID string) error
}

type Team struct {
	ID          string `jsonapi:"primary,teams"`
	Name        string `jsonapi:"attr,name,omitempty"`
	Description string `jsonapi:"attr,description,omitempty"`

	// Relations
	Account          *Account          `jsonapi:"relation,account"`
	IdentityProvider *IdentityProvider `jsonapi:"relation,identity-provider"`
	Users            []*User           `jsonapi:"relation,users"`
}

type TeamCreateOptions struct {
	ID          string  `jsonapi:"primary,teams"`
	Name        *string `jsonapi:"attr,name"`
	Description *string `jsonapi:"attr,description"`

	// Relations
	Account          *Account          `jsonapi:"relation,account,omitempty"`
	IdentityProvider *IdentityProvider `jsonapi:"relation,identity-provider,omitempty"`
	Users            []*User           `jsonapi:"relation,users,omitempty"`
}

type TeamList struct {
	*Pagination
	Items []*Team
}

type TeamListOptions struct {
	ListOptions

	Team             *string `url:"filter[team],omitempty"`
	Name             *string `url:"filter[name],omitempty"`
	Account          *string `url:"filter[account],omitempty"`
	IdentityProvider *string `url:"filter[identity-provider],omitempty"`
	Query            *string `url:"query,omitempty"`
	Sort             *string `url:"sort,omitempty"`
	Include          *string `url:"include,omitempty"`
}

type TeamUpdateOptions struct {
	ID          string  `jsonapi:"primary,teams"`
	Name        *string `jsonapi:"attr,name,omitempty"`
	Description *string `jsonapi:"attr,description,omitempty"`

	// Relations
	Users []*User `jsonapi:"relation,users"`
}

type Teams interface {
	List(ctx context.Context, options TeamListOptions) (*TeamList, error)
	Create(ctx context.Context, options TeamCreateOptions) (*Team, error)
	Read(ctx context.Context, teamID string) (*Team, error)
	Update(ctx context.Context, teamID string, options TeamUpdateOptions) (*Team, error)
	Delete(ctx context.Context, teamID string) error
}

type Upstream struct {
	ID string `jsonapi:"primary,workspaces"`
}

type User struct {
	ID          string     `jsonapi:"primary,users"`
	Status      UserStatus `jsonapi:"attr,status,omitempty"`
	Email       string     `jsonapi:"attr,email,omitempty"`
	Username    string     `jsonapi:"attr,username,omitempty"`
	FullName    string     `jsonapi:"attr,full-name,omitempty"`
	CreatedAt   time.Time  `jsonapi:"attr,created-at,iso8601"`
	LastLoginAt time.Time  `jsonapi:"attr,last-login-at,iso8601"`

	// Relations
	Teams             []*Team             `jsonapi:"relation,teams"`
	IdentityProviders []*IdentityProvider `jsonapi:"relation,identity-providers"`
}

type UserList struct {
	*Pagination
	Items []*User
}

type UserListOptions struct {
	ListOptions

	User             *string `url:"filter[user],omitempty"`
	Email            *string `url:"filter[email],omitempty"`
	IdentityProvider *string `url:"filter[identity-provider],omitempty"`
	Query            *string `url:"query,omitempty"`
	Sort             *string `url:"sort,omitempty"`
	Include          *string `url:"include,omitempty"`
}

type UserStatus string

type Users interface {
	List(ctx context.Context, options UserListOptions) (*UserList, error)
	Read(ctx context.Context, userID string) (*User, error)
}

type Variable struct {
	ID          string       `jsonapi:"primary,vars"`
	Key         string       `jsonapi:"attr,key"`
	Value       string       `jsonapi:"attr,value"`
	Category    CategoryType `jsonapi:"attr,category"`
	Description string       `jsonapi:"attr,description"`
	HCL         bool         `jsonapi:"attr,hcl"`
	Sensitive   bool         `jsonapi:"attr,sensitive"`
	Final       bool         `jsonapi:"attr,final"`

	// Relations
	Workspace   *Workspace   `jsonapi:"relation,workspace"`
	Environment *Environment `jsonapi:"relation,environment"`
	Account     *Account     `jsonapi:"relation,account"`
}

type VariableCreateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,vars"`

	// The name of the variable.
	Key *string `jsonapi:"attr,key"`

	// The value of the variable.
	Value *string `jsonapi:"attr,value,omitempty"`

	// Whether this is a Terraform or environment variable.
	Category *CategoryType `jsonapi:"attr,category"`

	// Variable description.
	Description *string `jsonapi:"attr,description"`

	// Whether to evaluate the value of the variable as a string of HCL code.
	HCL *bool `jsonapi:"attr,hcl,omitempty"`

	// Whether the value is sensitive.
	Sensitive *bool `jsonapi:"attr,sensitive,omitempty"`

	// Whether the value is final.
	Final *bool `jsonapi:"attr,final,omitempty"`

	// The workspace that owns the variable.
	Workspace *Workspace `jsonapi:"relation,workspace,omitempty"`

	// The environment that owns the variable.
	Environment *Environment `jsonapi:"relation,environment,omitempty"`

	// The account  that owns the variable.
	Account *Account `jsonapi:"relation,account,omitempty"`

	QueryOptions *VariableWriteQueryOptions
}

type VariableFilter struct {
	// Filter by ID
	Var *string `url:"var,omitempty"`

	// Filter by key
	Key *string `url:"key,omitempty"`

	// Filter by category
	Category *string `url:"category,omitempty"`

	// Scope filters.
	Workspace   *string `url:"workspace,omitempty"`
	Environment *string `url:"environment,omitempty"`
	Account     *string `url:"account,omitempty"`
}

type VariableList struct {
	*Pagination
	Items []*Variable
}

type VariableListOptions struct {
	ListOptions

	// The comma-separated list of attributes.
	Sort *string `url:"sort,omitempty"`

	// The comma-separated list of relationship paths.
	Include *string `url:"include,omitempty"`

	// Filters
	Filter *VariableFilter `url:"filter,omitempty"`
}

type VariableUpdateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,vars"`

	// The name of the variable.
	Key *string `jsonapi:"attr,key,omitempty"`

	// The value of the variable.
	Value *string `jsonapi:"attr,value,omitempty"`

	// The description of the variable.
	Description *string `jsonapi:"attr,description,omitempty"`

	// Whether to evaluate the value of the variable as a string of HCL code.
	HCL *bool `jsonapi:"attr,hcl,omitempty"`

	// Whether the value is sensitive.
	Sensitive *bool `jsonapi:"attr,sensitive,omitempty"`

	// Whether the value is final.
	Final        *bool `jsonapi:"attr,final,omitempty"`
	QueryOptions *VariableWriteQueryOptions
}

type VariableWriteQueryOptions struct {
	Force *bool `url:"force,omitempty"`
}

type Variables interface {
	// List variables by filter options.
	List(ctx context.Context, options VariableListOptions) (*VariableList, error)

	// Create is used to create a new variable.
	Create(ctx context.Context, options VariableCreateOptions) (*Variable, error)

	// Read a variable by its ID.
	Read(ctx context.Context, variableID string) (*Variable, error)

	// Update values of an existing variable.
	Update(ctx context.Context, variableID string, options VariableUpdateOptions) (*Variable, error)

	// Delete a variable by its ID.
	Delete(ctx context.Context, variableID string) error
}

type VcsProvider struct {
	ID       string   `jsonapi:"primary,vcs-providers"`
	Name     string   `jsonapi:"attr,name"`
	Url      string   `jsonapi:"attr,url"`
	VcsType  VcsType  `jsonapi:"attr,vcs-type"`
	AuthType AuthType `jsonapi:"attr,auth-type"`
	OAuth    *OAuth   `jsonapi:"attr,oauth"`
	Token    *string  `jsonapi:"attr,token"`
	Username *string  `jsonapi:"attr,username"`
	IsShared bool     `jsonapi:"attr,is-shared"`

	// Relations
	Environments []*Environment `jsonapi:"relation,environments"`
	Account      *Account       `jsonapi:"relation,account"`
	AgentPool    *AgentPool     `jsonapi:"relation,agent-pool"`
}

type VcsProviderCreateOptions struct {
	ID       string   `jsonapi:"primary,vcs-providers"`
	Name     *string  `jsonapi:"attr,name"`
	VcsType  VcsType  `jsonapi:"attr,vcs-type"`
	AuthType AuthType `jsonapi:"attr,auth-type"`
	OAuth    *OAuth   `jsonapi:"attr,oauth"`
	Token    string   `jsonapi:"attr,token"`
	Url      *string  `jsonapi:"attr,url"`
	Username *string  `jsonapi:"attr,username"`
	IsShared *bool    `jsonapi:"attr,is-shared,omitempty"`

	// Relations
	Environments []*Environment `jsonapi:"relation,environments,omitempty"`
	Account      *Account       `jsonapi:"relation,account,omitempty"`
	AgentPool    *AgentPool     `jsonapi:"relation,agent-pool,omitempty"`
}

type VcsProviderUpdateOptions struct {
	// For internal use only!
	ID       string  `jsonapi:"primary,vcs-providers"`
	Name     *string `jsonapi:"attr,name,omitempty"`
	Token    *string `jsonapi:"attr,token,omitempty"`
	Url      *string `jsonapi:"attr,url,omitempty"`
	Username *string `jsonapi:"attr,username,omitempty"`
	IsShared *bool   `jsonapi:"attr,is-shared,omitempty"`

	// Relations
	Environments []*Environment `jsonapi:"relation,environments"`
	AgentPool    *AgentPool     `jsonapi:"relation,agent-pool"`
}

type VcsProviders interface {
	// List the vcs providers.
	List(ctx context.Context, options VcsProvidersListOptions) (*VcsProvidersList, error)
	Create(ctx context.Context, options VcsProviderCreateOptions) (*VcsProvider, error)
	Read(ctx context.Context, vcsProvider string) (*VcsProvider, error)
	Update(ctx context.Context, vcsProvider string, options VcsProviderUpdateOptions) (*VcsProvider, error)
	Delete(ctx context.Context, vcsProvider string) error
}

type VcsProvidersList struct {
	*Pagination
	Items []*VcsProvider
}

type VcsProvidersListOptions struct {
	ListOptions

	// Filter by identifier.
	ID *string `url:"filter[vcs-provider],omitempty"`

	// Query string.
	Query *string `url:"query,omitempty"`

	// The comma-separated list of attributes.
	Sort *string `url:"sort,omitempty"`

	// Filter by vcs-type
	VcsType *VcsType `url:"filter[vcs-type],omitempty"`

	// Scope filters.
	Environment *string `url:"filter[environment],omitempty"`
	Account     *string `url:"filter[account],omitempty"`
	AgentPool   *string `url:"filter[agent-pool],omitempty"`
}

type VcsRevision struct {
	ID             string `jsonapi:"primary,vcs-revisions"`
	Branch         string `jsonapi:"attr,branch"`
	CommitSha      string `jsonapi:"attr,commit-sha"`
	CommitMessage  string `jsonapi:"attr,commit-message"`
	SenderUsername string `jsonapi:"attr,sender-username"`
}

type VcsRevisions interface {
	// Read reads a VCS revision by its ID.
	Read(ctx context.Context, vcsRevisionID string) (*VcsRevision, error)
}

type VcsType string

type Webhook struct {
	ID              string     `jsonapi:"primary,webhooks"`
	Enabled         bool       `jsonapi:"attr,enabled"`
	LastTriggeredAt *time.Time `jsonapi:"attr,last-triggered-at,iso8601"`
	Name            string     `jsonapi:"attr,name"`

	// Relations
	Workspace   *Workspace         `jsonapi:"relation,workspace"`
	Environment *Environment       `jsonapi:"relation,environment"`
	Account     *Account           `jsonapi:"relation,account"`
	Endpoint    *Endpoint          `jsonapi:"relation,endpoint"`
	Events      []*EventDefinition `jsonapi:"relation,events"`
}

type WebhookCreateOptions struct {
	ID      string  `jsonapi:"primary,webhooks"`
	Enabled *bool   `jsonapi:"attr,enabled,omitempty"`
	Name    *string `jsonapi:"attr,name"`

	// Relations
	Workspace   *Workspace         `jsonapi:"relation,workspace,omitempty"`
	Environment *Environment       `jsonapi:"relation,environment,omitempty"`
	Account     *Account           `jsonapi:"relation,account"`
	Endpoint    *Endpoint          `jsonapi:"relation,endpoint"`
	Events      []*EventDefinition `jsonapi:"relation,events"`
}

type WebhookHeader struct {
	Name      string `json:"name"`
	Value     string `json:"value"`
	Sensitive bool   `json:"sensitive"`
}

type WebhookIntegration struct {
	ID              string           `jsonapi:"primary,webhook-integrations"`
	Name            string           `jsonapi:"attr,name"`
	Enabled         bool             `jsonapi:"attr,enabled"`
	IsShared        bool             `jsonapi:"attr,is-shared"`
	LastTriggeredAt *time.Time       `jsonapi:"attr,last-triggered-at,iso8601"`
	Url             string           `jsonapi:"attr,url"`
	SecretKey       string           `jsonapi:"attr,secret-key"`
	Timeout         int              `jsonapi:"attr,timeout"`
	MaxAttempts     int              `jsonapi:"attr,max-attempts"`
	HttpMethod      string           `jsonapi:"attr,http-method"`
	Headers         []*WebhookHeader `jsonapi:"attr,headers"`

	// Relations
	Environments []*Environment     `jsonapi:"relation,environments"`
	Account      *Account           `jsonapi:"relation,account"`
	Events       []*EventDefinition `jsonapi:"relation,events"`
}

type WebhookIntegrationCreateOptions struct {
	ID       string  `jsonapi:"primary,webhook-integrations"`
	Name     *string `jsonapi:"attr,name"`
	Enabled  *bool   `jsonapi:"attr,enabled,omitempty"`
	IsShared *bool   `jsonapi:"attr,is-shared,omitempty"`

	Url         *string          `jsonapi:"attr,url"`
	SecretKey   *string          `jsonapi:"attr,secret-key,omitempty"`
	Timeout     *int             `jsonapi:"attr,timeout,omitempty"`
	MaxAttempts *int             `jsonapi:"attr,max-attempts,omitempty"`
	Headers     []*WebhookHeader `jsonapi:"attr,headers,omitempty"`

	Environments []*Environment     `jsonapi:"relation,environments,omitempty"`
	Account      *Account           `jsonapi:"relation,account"`
	Events       []*EventDefinition `jsonapi:"relation,events,omitempty"`
}

type WebhookIntegrationList struct {
	*Pagination
	Items []*WebhookIntegration
}

type WebhookIntegrationListOptions struct {
	ListOptions

	Query       *string `url:"query,omitempty"`
	Sort        *string `url:"sort,omitempty"`
	Enabled     *bool   `url:"filter[enabled],omitempty"`
	Event       *string `url:"filter[event],omitempty"`
	Environment *string `url:"filter[environment],omitempty"`
	Account     *string `url:"filter[account],omitempty"`
}

type WebhookIntegrationUpdateOptions struct {
	ID       string  `jsonapi:"primary,webhook-integrations"`
	Name     *string `jsonapi:"attr,name,omitempty"`
	Enabled  *bool   `jsonapi:"attr,enabled,omitempty"`
	IsShared *bool   `jsonapi:"attr,is-shared,omitempty"`

	Url         *string          `jsonapi:"attr,url,omitempty"`
	SecretKey   *string          `jsonapi:"attr,secret-key,omitempty"`
	Timeout     *int             `jsonapi:"attr,timeout,omitempty"`
	MaxAttempts *int             `jsonapi:"attr,max-attempts,omitempty"`
	Headers     []*WebhookHeader `jsonapi:"attr,headers,omitempty"`

	Environments []*Environment     `jsonapi:"relation,environments"`
	Events       []*EventDefinition `jsonapi:"relation,events"`
}

type WebhookIntegrations interface {
	List(ctx context.Context, options WebhookIntegrationListOptions) (*WebhookIntegrationList, error)
	Create(ctx context.Context, options WebhookIntegrationCreateOptions) (*WebhookIntegration, error)
	Read(ctx context.Context, wi string) (*WebhookIntegration, error)
	Update(ctx context.Context, wi string, options WebhookIntegrationUpdateOptions) (*WebhookIntegration, error)
	Delete(ctx context.Context, wi string) error
}

type WebhookList struct {
	*Pagination
	Items []*Webhook
}

type WebhookListOptions struct {
	ListOptions

	// Query string.
	Query *string `url:"query,omitempty"`

	Name *string `url:"query,omitempty"`

	// The comma-separated list of attributes.
	Sort *string `url:"sort,omitempty"`

	// The comma-separated list of relationship paths.
	Include *string `url:"include,omitempty"`

	// Filter by enabled
	Enabled *bool `url:"filter[enabled],omitempty"`

	// Event filter
	Event *string `url:"filter[event],omitempty"`

	// Scope filters.
	Workspace   *string `url:"filter[workspace],omitempty"`
	Environment *string `url:"filter[environment],omitempty"`
	Account     *string `url:"filter[account],omitempty"`
}

type WebhookUpdateOptions struct {
	// For internal use only!
	ID      string  `jsonapi:"primary,webhooks"`
	Enabled *bool   `jsonapi:"attr,enabled,omitempty"`
	Name    *string `jsonapi:"attr,name"`

	// Relations
	Endpoint *Endpoint          `jsonapi:"relation,endpoint"`
	Events   []*EventDefinition `jsonapi:"relation,events"`
}

type Webhooks interface {
	// List the webhooks.
	List(ctx context.Context, options WebhookListOptions) (*WebhookList, error)
	Create(ctx context.Context, options WebhookCreateOptions) (*Webhook, error)
	Read(ctx context.Context, webhook string) (*Webhook, error)
	Update(ctx context.Context, webhook string, options WebhookUpdateOptions) (*Webhook, error)
	Delete(ctx context.Context, webhook string) error
}

type Workspace struct {
	ID                        string                 `jsonapi:"primary,workspaces"`
	Actions                   *WorkspaceActions      `jsonapi:"attr,actions"`
	AutoApply                 bool                   `jsonapi:"attr,auto-apply"`
	ForceLatestRun            bool                   `jsonapi:"attr,force-latest-run"`
	DeletionProtectionEnabled bool                   `jsonapi:"attr,deletion-protection-enabled"`
	CanQueueDestroyPlan       bool                   `jsonapi:"attr,can-queue-destroy-plan"`
	CreatedAt                 time.Time              `jsonapi:"attr,created-at,iso8601"`
	FileTriggersEnabled       bool                   `jsonapi:"attr,file-triggers-enabled"`
	Locked                    bool                   `jsonapi:"attr,locked"`
	MigrationEnvironment      string                 `jsonapi:"attr,migration-environment"`
	Name                      string                 `jsonapi:"attr,name"`
	Operations                bool                   `jsonapi:"attr,operations"`
	ExecutionMode             WorkspaceExecutionMode `jsonapi:"attr,execution-mode"`
	Permissions               *WorkspacePermissions  `jsonapi:"attr,permissions"`
	TerraformVersion          string                 `jsonapi:"attr,terraform-version"`
	VCSRepo                   *WorkspaceVCSRepo      `jsonapi:"attr,vcs-repo"`
	WorkingDirectory          string                 `jsonapi:"attr,working-directory"`
	ApplySchedule             string                 `jsonapi:"attr,apply-schedule"`
	DestroySchedule           string                 `jsonapi:"attr,destroy-schedule"`
	HasResources              bool                   `jsonapi:"attr,has-resources"`
	AutoQueueRuns             WorkspaceAutoQueueRuns `jsonapi:"attr,auto-queue-runs"`
	Hooks                     *Hooks                 `jsonapi:"attr,hooks"`
	RunOperationTimeout       *int                   `jsonapi:"attr,run-operation-timeout"`
	VarFiles                  []string               `jsonapi:"attr,var-files"`

	// Relations
	CurrentRun    *Run           `jsonapi:"relation,current-run"`
	Environment   *Environment   `jsonapi:"relation,environment"`
	CreatedBy     *User          `jsonapi:"relation,created-by"`
	VcsProvider   *VcsProvider   `jsonapi:"relation,vcs-provider"`
	AgentPool     *AgentPool     `jsonapi:"relation,agent-pool"`
	ModuleVersion *ModuleVersion `jsonapi:"relation,module-version,omitempty"`
	Tags          []*Tag         `jsonapi:"relation,tags"`
}

type WorkspaceActions struct {
	IsDestroyable bool `json:"is-destroyable"`
}

type WorkspaceAutoQueueRuns string

type WorkspaceCreateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,workspaces"`

	// Whether to automatically apply changes when a Terraform plan is successful.
	AutoApply *bool `jsonapi:"attr,auto-apply,omitempty"`

	// Whether to automatically raise the priority of the latest new run.
	ForceLatestRun *bool `jsonapi:"attr,force-latest-run,omitempty"`

	// Whether to prevent deletion when the workspace has resources.
	DeletionProtectionEnabled *bool `jsonapi:"attr,deletion-protection-enabled,omitempty"`

	// The name of the workspace, which can only include letters, numbers, -,
	// and _. This will be used as an identifier and must be unique in the
	// environment.
	Name *string `jsonapi:"attr,name"`

	// Whether the workspace will use remote or local execution mode.
	Operations    *bool                   `jsonapi:"attr,operations,omitempty"`
	ExecutionMode *WorkspaceExecutionMode `jsonapi:"attr,execution-mode,omitempty"`

	// The version of Terraform to use for this workspace. Upon creating a
	// workspace, the latest version is selected unless otherwise specified.
	TerraformVersion *string `jsonapi:"attr,terraform-version,omitempty"`

	// Settings for the workspace's VCS repository. If omitted, the workspace is
	// created without a VCS repo. If included, you must specify at least the
	// oauth-token-id and identifier keys below.
	VCSRepo *WorkspaceVCSRepoOptions `jsonapi:"attr,vcs-repo,omitempty"`

	// Contains configuration for custom hooks,
	// which can be triggered before or after plan or apply phases
	Hooks *HooksOptions `jsonapi:"attr,hooks,omitempty"`

	// A relative path that Terraform will execute within. This defaults to the
	// root of your repository and is typically set to a subdirectory matching the
	// environment when multiple environments exist within the same repository.
	WorkingDirectory *string `jsonapi:"attr,working-directory,omitempty"`

	// Indicates if runs have to be queued automatically when a new configuration version is uploaded.
	AutoQueueRuns *WorkspaceAutoQueueRuns `jsonapi:"attr,auto-queue-runs,omitempty"`

	// Specifies the VcsProvider for workspace vcs-repo. Required if vcs-repo attr passed
	VcsProvider *VcsProvider `jsonapi:"relation,vcs-provider,omitempty"`

	// Specifies the Environment for workspace.
	Environment *Environment `jsonapi:"relation,environment"`

	// Specifies the AgentPool for workspace.
	AgentPool *AgentPool `jsonapi:"relation,agent-pool,omitempty"`

	// Specifies the VarFiles for workspace.
	VarFiles []string `jsonapi:"attr,var-files"`

	// Specifies the ModuleVersion based on create workspace
	ModuleVersion *ModuleVersion `jsonapi:"relation,module-version,omitempty"`

	// Specifies the number of minutes run operation can be executed before termination.
	RunOperationTimeout *int `jsonapi:"attr,run-operation-timeout"`

	// Specifies tags assigned to the workspace
	Tags []*Tag `jsonapi:"relation,tags,omitempty"`
}

type WorkspaceExecutionMode string

type WorkspaceFilter struct {
	Id          *string `url:"workspace,omitempty"`
	Account     *string `url:"account,omitempty"`
	Environment *string `url:"environment,omitempty"`
	Name        *string `url:"name,omitempty"`
	Tag         *string `url:"tag,omitempty"`
	AgentPool   *string `url:"agent-pool,omitempty"`
}

type WorkspaceList struct {
	*Pagination
	Items []*Workspace
}

type WorkspaceListOptions struct {
	ListOptions
	Include string           `url:"include,omitempty"`
	Filter  *WorkspaceFilter `url:"filter,omitempty"`
}

type WorkspacePermissions struct {
	CanDestroy        bool `json:"can-destroy"`
	CanForceUnlock    bool `json:"can-force-unlock"`
	CanLock           bool `json:"can-lock"`
	CanQueueApply     bool `json:"can-queue-apply"`
	CanQueueDestroy   bool `json:"can-queue-destroy"`
	CanQueueRun       bool `json:"can-queue-run"`
	CanReadSettings   bool `json:"can-read-settings"`
	CanUnlock         bool `json:"can-unlock"`
	CanUpdate         bool `json:"can-update"`
	CanUpdateVariable bool `json:"can-update-variable"`
}

type WorkspaceRunScheduleOptions struct {
	ApplySchedule   *string `json:"apply-schedule"`
	DestroySchedule *string `json:"destroy-schedule"`
}

type WorkspaceTags interface {
	Add(ctx context.Context, wsID string, tags []*TagRelation) error
	Replace(ctx context.Context, wsID string, tags []*TagRelation) error
	Delete(ctx context.Context, wsID string, tags []*TagRelation) error
}

type WorkspaceUpdateOptions struct {
	// For internal use only!
	ID string `jsonapi:"primary,workspaces"`

	// Whether to automatically apply changes when a Terraform plan is successful.
	AutoApply *bool `jsonapi:"attr,auto-apply,omitempty"`

	// Whether to automatically raise the priority of the latest new run.
	ForceLatestRun *bool `jsonapi:"attr,force-latest-run,omitempty"`

	// Whether to prevent deletion when the workspace has resources.
	DeletionProtectionEnabled *bool `jsonapi:"attr,deletion-protection-enabled,omitempty"`

	// A new name for the workspace, which can only include letters, numbers, -,
	// and _. This will be used as an identifier and must be unique in the
	// environment. Warning: Changing a workspace's name changes its URL in the
	// API and UI.
	Name *string `jsonapi:"attr,name,omitempty"`

	// Whether to filter runs based on the changed files in a VCS push. If
	// enabled, the working directory and trigger prefixes describe a set of
	// paths which must contain changes for a VCS push to trigger a run. If
	// disabled, any push will trigger a run.
	FileTriggersEnabled *bool `jsonapi:"attr,file-triggers-enabled,omitempty"`

	// Whether the workspace will use remote or local execution mode.
	Operations    *bool                   `jsonapi:"attr,operations,omitempty"`
	ExecutionMode *WorkspaceExecutionMode `jsonapi:"attr,execution-mode,omitempty"`

	// The version of Terraform to use for this workspace.
	TerraformVersion *string `jsonapi:"attr,terraform-version,omitempty"`

	// To delete a workspace's existing VCS repo, specify null instead of an
	// object. To modify a workspace's existing VCS repo, include whichever of
	// the keys below you wish to modify. To add a new VCS repo to a workspace
	// that didn't previously have one, include at least the oauth-token-id and
	// identifier keys.
	VCSRepo *WorkspaceVCSRepoOptions `jsonapi:"attr,vcs-repo"`

	// Contains configuration for custom hooks,
	// which can be triggered before init, before or after plan or apply phases
	Hooks *HooksOptions `jsonapi:"attr,hooks,omitempty"`

	// A relative path that Terraform will execute within. This defaults to the
	// root of your repository and is typically set to a subdirectory matching
	// the environment when multiple environments exist within the same
	// repository.
	WorkingDirectory *string `jsonapi:"attr,working-directory,omitempty"`

	// Indicates if runs have to be queued automatically when a new configuration version is uploaded.
	AutoQueueRuns *WorkspaceAutoQueueRuns `jsonapi:"attr,auto-queue-runs,omitempty"`

	// Specifies the VcsProvider for workspace vcs-repo.
	VcsProvider *VcsProvider `jsonapi:"relation,vcs-provider"`

	// Specifies the AgentPool for workspace.
	AgentPool *AgentPool `jsonapi:"relation,agent-pool"`

	//Specifies the VarFiles for workspace.
	VarFiles []string `jsonapi:"attr,var_files"`

	// Specifies the ModuleVersion based on create workspace
	ModuleVersion *ModuleVersion `jsonapi:"relation,module-version"`

	// Specifies the number of minutes run operation can be executed before termination.
	RunOperationTimeout *int `jsonapi:"attr,run-operation-timeout"`
}

type WorkspaceVCSRepo struct {
	Branch            string   `json:"branch"`
	Identifier        string   `json:"identifier"`
	IngressSubmodules bool     `json:"ingress-submodules"`
	Path              string   `json:"path"`
	TriggerPrefixes   []string `json:"trigger-prefixes,omitempty"`
	DryRunsEnabled    bool     `json:"dry-runs-enabled"`
}

type WorkspaceVCSRepoOptions struct {
	Branch            *string   `json:"branch,omitempty"`
	Identifier        *string   `json:"identifier,omitempty"`
	IngressSubmodules *bool     `json:"ingress-submodules,omitempty"`
	Path              *string   `json:"path,omitempty"`
	TriggerPrefixes   *[]string `json:"trigger-prefixes,omitempty"`
	DryRunsEnabled    *bool     `json:"dry-runs-enabled,omitempty"`
}

type Workspaces interface {
	// List all the workspaces within an environment.
	List(ctx context.Context, options WorkspaceListOptions) (*WorkspaceList, error)

	// Create is used to create a new workspace.
	Create(ctx context.Context, options WorkspaceCreateOptions) (*Workspace, error)

	// Read a workspace by its environment ID and name.
	Read(ctx context.Context, environmentID, workspaceName string) (*Workspace, error)

	// ReadByID reads a workspace by its ID.
	ReadByID(ctx context.Context, workspaceID string) (*Workspace, error)

	// Update settings of an existing workspace.
	Update(ctx context.Context, workspaceID string, options WorkspaceUpdateOptions) (*Workspace, error)

	// Delete deletes a workspace by its ID.
	Delete(ctx context.Context, workspaceID string) error

	// SetSchedule sets run schedules for workspace.
	SetSchedule(ctx context.Context, workspaceID string, options WorkspaceRunScheduleOptions) (*Workspace, error)
}