groupprotectedenvironmentsservice_inf.go

// Code generated by ifacemaker; DO NOT EDIT.

package gitlab

// GroupProtectedEnvironmentsService is an interface for [gitlab.Client.GroupProtectedEnvironments]
type GroupProtectedEnvironmentsService interface {
	// ListGroupProtectedEnvironments returns a list of protected environments from
	// a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/ee/api/group_protected_environments.html#list-group-level-protected-environments
	ListGroupProtectedEnvironments(gid interface{}, opt *ListGroupProtectedEnvironmentsOptions, options ...RequestOptionFunc) ([]*GroupProtectedEnvironment, *Response, error)
	// GetGroupProtectedEnvironment returns a single group-level protected
	// environment.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/ee/api/group_protected_environments.html#get-a-single-protected-environment
	GetGroupProtectedEnvironment(gid interface{}, environment string, options ...RequestOptionFunc) (*GroupProtectedEnvironment, *Response, error)
	// ProtectGroupEnvironment protects a single group-level environment.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/ee/api/group_protected_environments.html#protect-a-single-environment
	ProtectGroupEnvironment(gid interface{}, opt *ProtectGroupEnvironmentOptions, options ...RequestOptionFunc) (*GroupProtectedEnvironment, *Response, error)
	// UpdateGroupProtectedEnvironment updates a single group-level protected
	// environment.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/ee/api/group_protected_environments.html#update-a-protected-environment
	UpdateGroupProtectedEnvironment(gid interface{}, environment string, opt *UpdateGroupProtectedEnvironmentOptions, options ...RequestOptionFunc) (*GroupProtectedEnvironment, *Response, error)
	// UnprotectGroupEnvironment unprotects the given protected group-level
	// environment.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/ee/api/group_protected_environments.html#unprotect-a-single-environment
	UnprotectGroupEnvironment(gid interface{}, environment string, options ...RequestOptionFunc) (*Response, error)
}