gitlab

package module
v1.46.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 1, 2026 License: Apache-2.0 Imports: 31 Imported by: 391

README

GitLab client-go (former github.com/xanzy/go-gitlab)

A GitLab API client enabling Go programs to interact with GitLab in a simple and uniform way.

Table of Contents

[[TOC]]

client-go 1.0 Has Been Released!

We're pleased to announce that version 1.0 has been released for the client-go library, which comes with a backwards-compatibility guarantee. For more details of our major release plans moving forward, and for migration guides, please see the Migration Guides section below!

Usage

import "gitlab.com/gitlab-org/api/client-go"

Construct a new GitLab client, then use the various services on the client to access different parts of the GitLab API. For example, to list all users:

git, err := gitlab.NewClient("yourtokengoeshere")
if err != nil {
    log.Fatalf("Failed to create client: %v", err)
}
users, _, err := git.Users.ListUsers(&gitlab.ListUsersOptions{})

There are a few With... option functions that can be used to customize the API client. For example, to set a custom base URL:

git, err := gitlab.NewClient("yourtokengoeshere", gitlab.WithBaseURL("https://git.mydomain.com/api/v4"))
if err != nil {
  log.Fatalf("Failed to create client: %v", err)
}
users, _, err := git.Users.ListUsers(&gitlab.ListUsersOptions{})

Some API methods have optional parameters that can be passed. For example, to list all projects for user "svanharmelen":

git := gitlab.NewClient("yourtokengoeshere")
opt := &gitlab.ListProjectsOptions{Search: gitlab.Ptr("svanharmelen")}
projects, _, err := git.Projects.ListProjects(opt)
Examples

The examples directory contains a couple for clear examples, of which one is partially listed here as well:

package main

import (
	"log"

	"gitlab.com/gitlab-org/api/client-go"
)

func main() {
	git, err := gitlab.NewClient("yourtokengoeshere")
	if err != nil {
		log.Fatalf("Failed to create client: %v", err)
	}

	// Create new project
	p := &gitlab.CreateProjectOptions{
		Name:                     gitlab.Ptr("My Project"),
		Description:              gitlab.Ptr("Just a test project to play with"),
		MergeRequestsAccessLevel: gitlab.Ptr(gitlab.EnabledAccessControl),
		SnippetsAccessLevel:      gitlab.Ptr(gitlab.EnabledAccessControl),
		Visibility:               gitlab.Ptr(gitlab.PublicVisibility),
	}
	project, _, err := git.Projects.CreateProject(p)
	if err != nil {
		log.Fatal(err)
	}

	// Add a new snippet
	s := &gitlab.CreateProjectSnippetOptions{
		Title:      gitlab.Ptr("Dummy Snippet"),
		FileName:   gitlab.Ptr("snippet.go"),
		Content:    gitlab.Ptr("package main...."),
		Visibility: gitlab.Ptr(gitlab.PublicVisibility),
	}
	_, _, err = git.ProjectSnippets.CreateSnippet(project.ID, s)
	if err != nil {
		log.Fatal(err)
	}
}
Use OAuth2 helper package

The following example demonstrates how to use the gitlab.com/gitlab-org/api/client-go/oauth2 package:

package main

import (
	"context"
	"fmt"
	"os/exec"

	gitlab "gitlab.com/gitlab-org/api/client-go"
	"gitlab.com/gitlab-org/api/client-go/gitlaboauth2"
)

func main() {
	ctx := context.Background()
	// Authorize with GitLab.com and OAuth2
	clientID := "aaa"
	redirectURL := "http://localhost:9999/auth/redirect"
	scopes := []string{"read_api"}
	config := gitlaboauth2.NewOAuth2Config("", clientID, redirectURL, scopes)

	server := gitlaboauth2.NewCallbackServer(config, ":9999", func(url string) error {
		return exec.Command("open", url).Start()
	})

	token, err := server.GetToken(ctx)
	if err != nil {
		panic(err)
	}

	client, err := gitlab.NewAuthSourceClient(gitlab.OAuthTokenSource{TokenSource: config.TokenSource(ctx, token)})
	if err != nil {
		panic(err)
	}

	user, _, err := client.Users.CurrentUser()
	if err != nil {
		panic(err)
	}

	fmt.Printf("Current user: %s\n", user.Username)
}
Use the config package (experimental)

The config package defines a configuration file format (YAML) to configure GitLab instances and their associated authentication methods combined in contexts (similar to what you might know from Kubernetes).

The configuration is located in the users config directory (e.g. XDG config dir), in gitlab/config.yaml.

A basic example for an OAuth flow for GitLab.com that stores the credentials in the systems keyring, looks like this:

version: gitlab.com/config/v1beta1

instances:
    - name: gitlab-com
      server: https://gitlab.com

auths:
    - name: oauth-keyring
      auth-info:
        oauth2:
            access-token-source:
                keyring:
                    service: client-go
                    user: access-token
            refresh-token-source:
                keyring:
                    service: client-go
                    user: refresh-token
contexts:
    - name: gitlab-com-keyring
      instance: gitlab-com
      auth: oauth-keyring

current-context: gitlab-com-keyring

An application with client-go is able to effortlessly create a new client using that configuration:

package main

import (
	"fmt"
	"log"

	"gitlab.com/gitlab-org/api/client-go"
	"gitlab.com/gitlab-org/api/client-go/config"
)

func main() {
	// Create a config with default location (~/.config/gitlab/config.yaml)
	cfg := config.New(
		config.WithOAuth2Settings(config.OAuth2Settings{
			AuthorizationFlowEnabled: true,
			CallbackServerListenAddr: ":7171",
			Browser: func(url string) error {
				fmt.Printf("Open: %s\n", url)
				return nil
			},
			ClientID:    "<your-client-id>",
			RedirectURL: "http://localhost:7171/auth/redirect",
			Scopes:      []string{"read_api"},
		}),
	)

	// Load the configuration
	if err := cfg.Load(); err != nil {
		log.Printf("Failed to load config: %v", err)
		return
	}

	client, err := cfg.NewClient(gitlab.WithUserAgent("my-app"))
	if err != nil {
		log.Fatalf("Failed to create client: %v", err)
	}

	// Use the client
	user, _, err := client.Users.CurrentUser()
	if err != nil {
		log.Fatalf("Failed to get current user: %v", err)
	}

	fmt.Printf("Authenticated as: %s (%s)\n", user.Name, user.Username)
}

For complete usage of go-gitlab, see the full package docs.

Installation

To install the library, use the following command:

go get gitlab.com/gitlab-org/api/client-go

Testing

The client-go project comes with a testing package at gitlab.com/gitlab-org/api/client-go/testing which contains a TestClient with gomock mocks for the individual services.

You can use them like this:

func TestMockExample(t *testing.T) {
	client := gitlabtesting.NewTestClient(t)
	opts := &gitlab.ListAgentsOptions{}
	expectedResp := &gitlab.Response{}
	pid := 1
	// Setup expectations
	client.MockClusterAgents.EXPECT().
		ListAgents(pid, opts).
		Return([]*gitlab.Agent{{ID: 1}}, expectedResp, nil)

	// Use the client in your test
	// You'd probably call your own code here that gets the client injected.
	// You can also retrieve a `gitlab.Client` object from `client.Client`.
	agents, resp, err := client.ClusterAgents.ListAgents(pid, opts)
	assert.NoError(t, err)
	assert.Equal(t, expectedResp, resp)
	assert.Len(t, agents, 1)
}
I want to generate my own mocks

You can! You can set up your own TestClient with mocks pretty easily:

func NewTestClient(t *testing.T) {
    // generate your mocks or instantiate a fake or whatever you like
    mockClusterAgentsService := newMockClusterAgentsService(t)
	client := &gitlab.Client{
		ClusterAgents: mockClusterAgentsService
	}

	return tc
}

The newMockClusterAgentsService must return a type that implements gitlab.ClusterAgentsInterface.

You can have a look at testing/client.go how it's implemented for gomock.

Compatibility

The client-go package will maintain compatibility with the officially supported Go releases at the time the package is released. According to the Go Release Policy, that's currently the two last major Go releases. This compatibility is reflected in the go directive of the go.mod file and the unit test matrix in .gitlab-ci.yml.

You may also use https://endoflife.date/go to quickly discover the supported Go versions.

Migration Guides

client-go will release a major update roughly once every 6 months to align to the Go release cycle. Each major release will publish a migration guide to help users migrate from the previous major release.

Contributing

Contributions are always welcome. For more information, check out the contributing guide.

Maintenance

This is a community maintained project. If you have a paid GitLab subscription, please note that this project is not packaged as a part of GitLab, and falls outside of the scope of support.

For more information, see GitLab's Statement of Support. Please fill out an issue in this projects issue tracker and someone from the community will respond as soon as they are available to help you.

Known GitLab Projects using this package

Documentation

Overview

Package gitlab implements a GitLab API client.

Example (BasicAuth)

Example_basicAuth demonstrates authenticating with username and password. This uses OAuth2 password credentials flow under the hood. 

// Note: The setupBasicAuthMock() function below is ONLY for the example purpose
// and has nothing to do with how a user will use client-go.
// In production, you would authenticate against a real GitLab instance.
client, server := setupBasicAuthMock()
defer server.Close()

// Use the authenticated client
projects, _, _ := client.Projects.ListProjects(nil)
fmt.Printf("Found %d projects\n", len(projects))

Output:
Found 2 projects
Example (FileUpload)

Example_fileUpload demonstrates uploading a file to a GitLab repository. 

// Note: The setupFileUploadMock() function below is ONLY for the example purpose
// and has nothing to do with how a user will use client-go.
// In production, you would use a real authenticated GitLab client.
client, server := setupFileUploadMock()
defer server.Close()

// Create a new file in the repository
opts := &gitlab.CreateFileOptions{
	Branch:        gitlab.Ptr("main"),
	Content:       gitlab.Ptr("# My Project\n\nDocumentation for this project."),
	CommitMessage: gitlab.Ptr("Add README"),
}

file, _, _ := client.RepositoryFiles.CreateFile(
	"my-group/my-project",
	"README.md",
	opts,
)

fmt.Printf("Created %s on branch %s\n", file.FilePath, file.Branch)

Output:
Created README.md on branch main
Example (KeysetPagination)

Example_keysetPagination demonstrates keyset-based pagination. Keyset pagination is more efficient for large datasets and prevents duplicates when data changes during pagination. 

// Note: The setupPaginationMock() function below is ONLY for the example purpose
// and has nothing to do with how a user will use client-go.
// In production, you would use a real authenticated GitLab client.
client, server := setupPaginationMock(true)
defer server.Close()

// Configure keyset pagination
opts := &gitlab.ListProjectsOptions{
	ListOptions: gitlab.ListOptions{
		OrderBy:    "id",
		Pagination: "keyset",
		PerPage:    5,
		Sort:       "asc",
	},
	Owned: gitlab.Ptr(true),
}

// Scan2 works with both pagination types
count := 0
for range gitlab.Must(gitlab.Scan2(func(p gitlab.PaginationOptionFunc) ([]*gitlab.Project, *gitlab.Response, error) {
	return client.Projects.ListProjects(opts, p)
})) {
	count++
}

fmt.Printf("Iterated over %d projects\n", count)

Output:
Iterated over 2 projects
Example (Pagination)

Example_pagination demonstrates standard offset-based pagination. This automatically handles pagination using page numbers. 

// Note: The setupPaginationMock() function below is ONLY for the example purpose
// and has nothing to do with how a user will use client-go.
// In production, you would use a real authenticated GitLab client.
client, server := setupPaginationMock(false)
defer server.Close()

// Configure pagination options
opts := &gitlab.ListProjectsOptions{
	ListOptions: gitlab.ListOptions{
		PerPage: 10,
		Page:    1,
	},
	Owned: gitlab.Ptr(true),
}

// Scan2 automatically handles pagination
count := 0
for range gitlab.Must(gitlab.Scan2(func(p gitlab.PaginationOptionFunc) ([]*gitlab.Project, *gitlab.Response, error) {
	return client.Projects.ListProjects(opts, p)
})) {
	count++
}

fmt.Printf("Iterated over %d projects\n", count)

Output:
Iterated over 2 projects

Index

Examples

Constants

View Source 
const (
	AccessTokenHeaderName = "Private-Token"
	JobTokenHeaderName    = "Job-Token"
)
View Source 
const (
	// GraphQLAPIEndpoint defines the endpoint URI for the GraphQL backend
	GraphQLAPIEndpoint = "/api/graphql"
)

Variables

View Source 
var (
	ErrUserActivatePrevented         = errors.New("cannot activate a user that is blocked by admin or by LDAP synchronization")
	ErrUserApprovePrevented          = errors.New("cannot approve a user that is blocked by admin or by LDAP synchronization")
	ErrUserBlockPrevented            = errors.New("cannot block a user that is already blocked by LDAP synchronization")
	ErrUserConflict                  = errors.New("user does not have a pending request")
	ErrUserDeactivatePrevented       = errors.New("cannot deactivate a user that is blocked by admin or by LDAP synchronization")
	ErrUserDisableTwoFactorPrevented = errors.New("cannot disable two factor authentication if not authenticated as administrator")
	ErrUserNotFound                  = errors.New("user does not exist")
	ErrUserRejectPrevented           = errors.New("cannot reject a user if not authenticated as administrator")
	ErrUserTwoFactorNotEnabled       = errors.New("cannot disable two factor authentication if not enabled")
	ErrUserUnblockPrevented          = errors.New("cannot unblock a user that is blocked by LDAP synchronization")
)

List a couple of standard errors.

View Source 
var ErrInvalidIDType = errors.New("the ID must be an int or a string")

ErrInvalidIDType is returned when a function expecting an ID as either an integer or string receives a different type. This error commonly occurs when working with GitLab resources like groups and projects which support both numeric IDs and path-based string identifiers.

View Source 
var (
	// ErrNotFound is returned for 404 Not Found errors
	ErrNotFound = errors.New("404 Not Found")
)

Functions

func CheckResponse 

func CheckResponse(r *http.Response) error

CheckResponse checks the API response for errors, and returns them if present.

func HasStatusCode added in v0.136.0 

func HasStatusCode(err error, statusCode int) bool

func HookEventToken added in v0.116.0 

func HookEventToken(r *http.Request) string

HookEventToken returns the token for the given request.

func Must added in v0.128.0 

func Must[T any](it iter.Seq2[T, error]) iter.Seq[T]

Must provides a single item iterator for the provided two item iterator and panics if an error happens. 

opts := &ListProjectsOptions{}
for p := range Must(Scan2(func(p PaginationOptionFunc) ([]*Project, *Response, error) {
	return c.Projects.ListProjects(opts, p)
})) {
	// do something with p
}

Attention: This API is experimental and may be subject to breaking changes to improve the API in the future.

func ParseHook added in v0.116.0 

func ParseHook(eventType EventType, payload []byte) (event any, err error)

ParseHook tries to parse both web- and system hooks.

Example usage: 

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
    payload, err := io.ReadAll(r.Body)
    if err != nil { ... }
    event, err := gitlab.ParseHook(gitlab.HookEventType(r), payload)
    if err != nil { ... }
    switch event := event.(type) {
    case *gitlab.PushEvent:
        processPushEvent(event)
    case *gitlab.MergeEvent:
        processMergeEvent(event)
    ...
    }
}

func ParseSystemhook added in v0.116.0 

func ParseSystemhook(payload []byte) (event any, err error)

ParseSystemhook parses the event payload. For recognized event types, a value of the corresponding struct type will be returned. An error will be returned for unrecognized event types.

Example usage: 

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
    payload, err := io.ReadAll(r.Body)
    if err != nil { ... }
    event, err := gitlab.ParseSystemhook(payload)
    if err != nil { ... }
    switch event := event.(type) {
    case *gitlab.PushSystemEvent:
        processPushSystemEvent(event)
    case *gitlab.MergeSystemEvent:
        processMergeSystemEvent(event)
    ...
    }
}

func ParseWebhook added in v0.116.0 

func ParseWebhook(eventType EventType, payload []byte) (event any, err error)

ParseWebhook parses the event payload. For recognized event types, a value of the corresponding struct type will be returned. An error will be returned for unrecognized event types.

Example usage: 

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
    payload, err := io.ReadAll(r.Body)
    if err != nil { ... }
    event, err := gitlab.ParseWebhook(gitlab.HookEventType(r), payload)
    if err != nil { ... }
    switch event := event.(type) {
    case *gitlab.PushEvent:
        processPushEvent(event)
    case *gitlab.MergeEvent:
        processMergeEvent(event)
    ...
    }
}

func PathEscape added in v0.116.0 

func PathEscape(s string) string

PathEscape is a helper function to escape a project identifier.

func Ptr added in v0.116.0 

func Ptr[T any](v T) *T

Ptr is a helper that returns a pointer to v.

func Scan added in v0.128.0 

func Scan[T any](f func(p PaginationOptionFunc) ([]T, *Response, error)) (iter.Seq[T], func() error)

Scan scans all pages for the given request function f and returns individual items in an iterator. If an error happens during pagination, the iterator stops immediately. The caller must consume the returned error function to retrieve potential errors. 

opts := &ListProjectsOptions{}
it, hasErr := Scan(func(p PaginationOptionFunc) ([]*Project, *Response, error) {
	return c.Projects.ListProjects(opts, p)
})
projects := slices.Collect(it)
if err := hasErr(); err != nil {
	return err
}

or with keyset-based pagination: 

opts := &ListProjectsOptions{
	ListOptions: ListOptions{
		OrderBy:    "id",
		Pagination: "keyset",
	},
}
it, hasErr := Scan(func(p PaginationOptionFunc) ([]*Project, *Response, error) {
	return c.Projects.ListProjects(opts, p)
})
projects := slices.Collect(it)
if err := hasErr(); err != nil {
	return err
}

Attention: This API is experimental and may be subject to breaking changes to improve the API in the future.

func Scan2 added in v0.128.0 

func Scan2[T any](f func(p PaginationOptionFunc) ([]T, *Response, error)) iter.Seq2[T, error]

Scan2 scans all pages for the given request function f and returns individual items and potential errors in an iterator. The caller must consume the error element of the iterator during each iteration to ensure that no errors happened. 

opts := &ListProjectsOptions{}
for p, err := range Scan2(func(p PaginationOptionFunc) ([]*Project, *Response, error) {
	return c.Projects.ListProjects(opts, p)
}) {
	if err != nil {
		return err
	}
	// do something with p
}

or with keyset-based pagination: 

opts := &ListProjectsOptions{
	ListOptions: ListOptions{
		OrderBy:    "id",
		Pagination: "keyset",
	},
}
for p, err := range Scan2(func(p PaginationOptionFunc) ([]*Project, *Response, error) {
	return c.Projects.ListProjects(opts, p)
}) {
	if err != nil {
		return err
	}
	// do something with p
}

Attention: This API is experimental and may be subject to breaking changes to improve the API in the future.

Example 
package main

import (
	"fmt"
	"log"

	gitlab "gitlab.com/gitlab-org/api/client-go"
)

func main() {
	// Create a client (this would normally use your GitLab instance URL and token)
	client, err := gitlab.NewAuthSourceClient(
		gitlab.AccessTokenAuthSource{"your-token"},
		gitlab.WithBaseURL("https://gitlab.example.com/api/v4"),
	)
	if err != nil {
		// Handle the error
		panic(err)
	}

	opts := &gitlab.ListProjectsOptions{}

	pager := func(pageOpt gitlab.PaginationOptionFunc) ([]*gitlab.Project, *gitlab.Response, error) {
		// Call ListProjects with pageOpt to retrieve the next page
		return client.Projects.ListProjects(opts, pageOpt)
	}

	// Create a project iterator
	projects := gitlab.Scan2(pager)

	// Iterate over the project iterator
	for project, err := range projects {
		// Errors are delivered inline — check for them and break the loop before using the value
		if err != nil {
			log.Println("ERROR:", err)
			break
		}

		fmt.Printf("- %s (ID: %d)\n", project.PathWithNamespace, project.ID)
	}
}

func ScanAndCollect added in v0.131.0 

func ScanAndCollect[T any](f func(p PaginationOptionFunc) ([]T, *Response, error)) ([]T, error)

ScanAndCollect is a convenience function that collects all results and returns them as a slice as well as an error if one happens. 

opts := &ListProjectsOptions{}
projects, err := ScanAndCollect(func(p PaginationOptionFunc) ([]*Project, *Response, error) {
	return c.Projects.ListProjects(opts, p)
}))
if err != nil {
	// handle the error
}
// do something with projects

Attention: This API is experimental and may be subject to breaking changes to improve the API in the future.

func ScanAndCollectN added in v1.43.0 

func ScanAndCollectN[T any](f func(p PaginationOptionFunc) ([]T, *Response, error), n int) ([]T, error)

ScanAndCollectN is a convenience function that collects at most n results and returns them as a slice as well as an error if one happens.

This is useful when you need a slice, e.g. for marshaling the data structures, passing the data to a function expecting a slice, or implementing custom sorting logic. If you want to iterate over all items, the iterator returned by Scan2 is a more memory efficient alternative.

n determines the number of items to collect:

  • n > 0: at most n items are returned
  • n == 0: the result is a nil slice (zero items)
  • n < 0: all items are returned (no limit)

Attention: This API is experimental and may be subject to breaking changes to improve the API in the future.

Example 
package main

import (
	"encoding/json"
	"os"

	gitlab "gitlab.com/gitlab-org/api/client-go"
)

func main() {
	// Create a client (this would normally use your GitLab instance URL and token)
	client, err := gitlab.NewAuthSourceClient(
		gitlab.AccessTokenAuthSource{"your-token"},
		gitlab.WithBaseURL("https://gitlab.example.com/api/v4"),
	)
	if err != nil {
		// Handle the error
		panic(err)
	}

	opts := &gitlab.ListProjectsOptions{}

	pager := func(pageOpt gitlab.PaginationOptionFunc) ([]*gitlab.Project, *gitlab.Response, error) {
		// Call ListProjects with pageOpt to retrieve the next page
		return client.Projects.ListProjects(opts, pageOpt)
	}

	// Retrieve at most 42 projects
	const limit = 42

	projects, err := gitlab.ScanAndCollectN(pager, limit)
	if err != nil {
		// Handle the error
		panic(err)
	}

	// Use the slice — here we serialize it to JSON, but you could sort it, pass it to another function, etc.
	// Note: if you want to iterate over items, use gitlab.Scan2() instead
	if err := json.NewEncoder(os.Stdout).Encode(projects); err != nil {
		panic(err)
	}
}

func Stringify 

func Stringify(message any) string

Stringify attempts to create a reasonable string representation of types in the GitLab library. It does things like resolve pointers to their values and omits struct fields with nil values.

Types

type AcceptMergeRequestOptions added in v0.4.0 

type AcceptMergeRequestOptions struct {
	AutoMerge                *bool   `url:"auto_merge,omitempty" json:"auto_merge,omitempty"`
	MergeCommitMessage       *string `url:"merge_commit_message,omitempty" json:"merge_commit_message,omitempty"`
	SquashCommitMessage      *string `url:"squash_commit_message,omitempty" json:"squash_commit_message,omitempty"`
	Squash                   *bool   `url:"squash,omitempty" json:"squash,omitempty"`
	ShouldRemoveSourceBranch *bool   `url:"should_remove_source_branch,omitempty" json:"should_remove_source_branch,omitempty"`
	SHA                      *string `url:"sha,omitempty" json:"sha,omitempty"`

	// Deprecated: use AutoMerge instead
	MergeWhenPipelineSucceeds *bool `url:"merge_when_pipeline_succeeds,omitempty" json:"merge_when_pipeline_succeeds,omitempty"`
}

AcceptMergeRequestOptions represents the available AcceptMergeRequest() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#merge-a-merge-request

type AccessControlValue added in v0.116.0 

type AccessControlValue string

AccessControlValue represents an access control value within GitLab, used for managing access to certain project features.

GitLab API docs: https://docs.gitlab.com/api/projects/ 

const (
	DisabledAccessControl AccessControlValue = "disabled"
	EnabledAccessControl  AccessControlValue = "enabled"
	PrivateAccessControl  AccessControlValue = "private"
	PublicAccessControl   AccessControlValue = "public"
)

List of available access control values.

GitLab API docs: https://docs.gitlab.com/api/projects/

type AccessLevelDetails added in v0.116.0 

type AccessLevelDetails struct {
	IntegerValue AccessLevelValue `json:"integer_value"`
	StringValue  string           `json:"string_value"`
}

type AccessLevelValue added in v0.2.0 

type AccessLevelValue int

AccessLevelValue represents a permission level within GitLab.

GitLab API docs: https://docs.gitlab.com/user/permissions/#roles 

const (
	NoPermissions            AccessLevelValue = 0
	MinimalAccessPermissions AccessLevelValue = 5
	GuestPermissions         AccessLevelValue = 10
	PlannerPermissions       AccessLevelValue = 15
	ReporterPermissions      AccessLevelValue = 20
	DeveloperPermissions     AccessLevelValue = 30
	MaintainerPermissions    AccessLevelValue = 40
	OwnerPermissions         AccessLevelValue = 50
	AdminPermissions         AccessLevelValue = 60
)

List of available access levels.

GitLab API docs: https://docs.gitlab.com/api/access_requests/#valid-access-levels

type AccessRequest added in v0.11.1 

type AccessRequest struct {
	ID          int64            `json:"id"`
	Username    string           `json:"username"`
	Name        string           `json:"name"`
	State       string           `json:"state"`
	CreatedAt   *time.Time       `json:"created_at"`
	RequestedAt *time.Time       `json:"requested_at"`
	AccessLevel AccessLevelValue `json:"access_level"`
}

AccessRequest represents a access request for a group or project.

GitLab API docs: https://docs.gitlab.com/api/access_requests/

type AccessRequestsService added in v0.11.1 

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

AccessRequestsService handles communication with the project/group access requests related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/access_requests/

func (*AccessRequestsService) ApproveGroupAccessRequest added in v0.11.1 

func (s *AccessRequestsService) ApproveGroupAccessRequest(gid any, user int64, opt *ApproveAccessRequestOptions, options ...RequestOptionFunc) (*AccessRequest, *Response, error)

func (*AccessRequestsService) ApproveProjectAccessRequest added in v0.11.1 

func (s *AccessRequestsService) ApproveProjectAccessRequest(pid any, user int64, opt *ApproveAccessRequestOptions, options ...RequestOptionFunc) (*AccessRequest, *Response, error)

func (*AccessRequestsService) DenyGroupAccessRequest added in v0.11.1 

func (s *AccessRequestsService) DenyGroupAccessRequest(gid any, user int64, options ...RequestOptionFunc) (*Response, error)

func (*AccessRequestsService) DenyProjectAccessRequest added in v0.11.1 

func (s *AccessRequestsService) DenyProjectAccessRequest(pid any, user int64, options ...RequestOptionFunc) (*Response, error)

func (*AccessRequestsService) ListGroupAccessRequests added in v0.11.1 

func (s *AccessRequestsService) ListGroupAccessRequests(gid any, opt *ListAccessRequestsOptions, options ...RequestOptionFunc) ([]*AccessRequest, *Response, error)

func (*AccessRequestsService) ListProjectAccessRequests added in v0.11.1 

func (s *AccessRequestsService) ListProjectAccessRequests(pid any, opt *ListAccessRequestsOptions, options ...RequestOptionFunc) ([]*AccessRequest, *Response, error)

func (*AccessRequestsService) RequestGroupAccess added in v0.11.1 

func (s *AccessRequestsService) RequestGroupAccess(gid any, options ...RequestOptionFunc) (*AccessRequest, *Response, error)

func (*AccessRequestsService) RequestProjectAccess added in v0.11.1 

func (s *AccessRequestsService) RequestProjectAccess(pid any, options ...RequestOptionFunc) (*AccessRequest, *Response, error)

type AccessRequestsServiceInterface added in v0.126.0 

type AccessRequestsServiceInterface interface {
	// ListProjectAccessRequests gets a list of access requests
	// viewable by the authenticated user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/access_requests/#list-access-requests-for-a-group-or-project
	// ListProjectAccessRequests gets a list of access requests
	// viewable by the authenticated user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/access_requests/#list-access-requests-for-a-group-or-project
	ListProjectAccessRequests(pid any, opt *ListAccessRequestsOptions, options ...RequestOptionFunc) ([]*AccessRequest, *Response, error)

	// ListGroupAccessRequests gets a list of access requests
	// viewable by the authenticated user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/access_requests/#list-access-requests-for-a-group-or-project
	ListGroupAccessRequests(gid any, opt *ListAccessRequestsOptions, options ...RequestOptionFunc) ([]*AccessRequest, *Response, error)

	// RequestProjectAccess requests access for the authenticated user
	// to a group or project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/access_requests/#request-access-to-a-group-or-project
	RequestProjectAccess(pid any, options ...RequestOptionFunc) (*AccessRequest, *Response, error)

	// RequestGroupAccess requests access for the authenticated user
	// to a group or project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/access_requests/#request-access-to-a-group-or-project
	RequestGroupAccess(gid any, options ...RequestOptionFunc) (*AccessRequest, *Response, error)

	// ApproveProjectAccessRequest approves an access request for the given user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/access_requests/#approve-an-access-request
	ApproveProjectAccessRequest(pid any, user int64, opt *ApproveAccessRequestOptions, options ...RequestOptionFunc) (*AccessRequest, *Response, error)

	// ApproveGroupAccessRequest approves an access request for the given user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/access_requests/#approve-an-access-request
	ApproveGroupAccessRequest(gid any, user int64, opt *ApproveAccessRequestOptions, options ...RequestOptionFunc) (*AccessRequest, *Response, error)

	// DenyProjectAccessRequest denies an access request for the given user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/access_requests/#deny-an-access-request
	DenyProjectAccessRequest(pid any, user int64, options ...RequestOptionFunc) (*Response, error)

	// DenyGroupAccessRequest denies an access request for the given user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/access_requests/#deny-an-access-request
	DenyGroupAccessRequest(gid any, user int64, options ...RequestOptionFunc) (*Response, error)
}

type AccessTokenAuthSource added in v0.132.0 

type AccessTokenAuthSource struct {
	Token string
}

AccessTokenAuthSource used as an AuthSource for various access tokens, like Personal-, Project- and Group- Access Tokens. Can be used for all tokens that authorize with the Private-Token header.

func (AccessTokenAuthSource) Header added in v0.132.0 

func (s AccessTokenAuthSource) Header(_ context.Context) (string, string, error)

func (AccessTokenAuthSource) Init added in v0.132.0 

func (AccessTokenAuthSource) Init(context.Context, *Client) error

type AccessTokenSort added in v1.46.0 

type AccessTokenSort string

AccessTokenSort represents the available sorting options for access tokens.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#list-all-group-access-tokens 

const (
	CreatedAsc   AccessTokenSort = "created_asc"
	CreatedDesc  AccessTokenSort = "created_desc"
	ExpiresAsc   AccessTokenSort = "expires_asc"
	ExpiresDesc  AccessTokenSort = "expires_desc"
	LastUsedAsc  AccessTokenSort = "last_used_asc"
	LastUsedDesc AccessTokenSort = "last_used_desc"
	NameAsc      AccessTokenSort = "name_asc"
	NameDesc     AccessTokenSort = "name_desc"
)

type AccessTokenState added in v0.129.0 

type AccessTokenState string

AccessTokenState identifies if an access token is active or inactive.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#list-all-group-access-tokens https://docs.gitlab.com/api/project_access_tokens/#list-all-project-access-tokens 

const (
	AccessTokenStateActive   AccessTokenState = "active"
	AccessTokenStateInactive AccessTokenState = "inactive"
)

type AddChangelogOptions added in v0.116.0 

type AddChangelogOptions struct {
	Version    *string  `url:"version,omitempty" json:"version,omitempty"`
	Branch     *string  `url:"branch,omitempty" json:"branch,omitempty"`
	ConfigFile *string  `url:"config_file,omitempty" json:"config_file,omitempty"`
	Date       *ISOTime `url:"date,omitempty" json:"date,omitempty"`
	File       *string  `url:"file,omitempty" json:"file,omitempty"`
	From       *string  `url:"from,omitempty" json:"from,omitempty"`
	Message    *string  `url:"message,omitempty" json:"message,omitempty"`
	To         *string  `url:"to,omitempty" json:"to,omitempty"`
	Trailer    *string  `url:"trailer,omitempty" json:"trailer,omitempty"`
}

AddChangelogOptions represents the available AddChangelog() options.

GitLab API docs: https://docs.gitlab.com/api/repositories/#add-changelog-data-to-a-changelog-file

type AddClusterOptions added in v0.116.0 

type AddClusterOptions struct {
	Name                *string                       `url:"name,omitempty" json:"name,omitempty"`
	Domain              *string                       `url:"domain,omitempty" json:"domain,omitempty"`
	Enabled             *bool                         `url:"enabled,omitempty" json:"enabled,omitempty"`
	Managed             *bool                         `url:"managed,omitempty" json:"managed,omitempty"`
	EnvironmentScope    *string                       `url:"environment_scope,omitempty" json:"environment_scope,omitempty"`
	PlatformKubernetes  *AddPlatformKubernetesOptions `url:"platform_kubernetes_attributes,omitempty" json:"platform_kubernetes_attributes,omitempty"`
	ManagementProjectID *string                       `url:"management_project_id,omitempty" json:"management_project_id,omitempty"`
}

AddClusterOptions represents the available AddCluster() options. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/project_clusters/#add-existing-cluster-to-project

type AddCommitDiscussionNoteOptions added in v0.11.2 

type AddCommitDiscussionNoteOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
}

AddCommitDiscussionNoteOptions represents the available AddCommitDiscussionNote() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#add-note-to-existing-commit-thread

type AddDeployKeyOptions 

type AddDeployKeyOptions struct {
	Key       *string    `url:"key,omitempty" json:"key,omitempty"`
	Title     *string    `url:"title,omitempty" json:"title,omitempty"`
	CanPush   *bool      `url:"can_push,omitempty" json:"can_push,omitempty"`
	ExpiresAt *time.Time `url:"expires_at,omitempty" json:"expires_at,omitempty"`
}

AddDeployKeyOptions represents the available ADDDeployKey() options.

GitLab API docs: https://docs.gitlab.com/api/deploy_keys/#add-deploy-key-for-a-project

type AddEmailOptions added in v0.4.0 

type AddEmailOptions struct {
	Email            *string `url:"email,omitempty" json:"email,omitempty"`
	SkipConfirmation *bool   `url:"skip_confirmation,omitempty" json:"skip_confirmation,omitempty"`
}

AddEmailOptions represents the available AddEmail() options.

GitLab API docs: https://docs.gitlab.com/api/user_email_addresses/#add-an-email-address

type AddEpicDiscussionNoteOptions added in v0.11.2 

type AddEpicDiscussionNoteOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
}

AddEpicDiscussionNoteOptions represents the available AddEpicDiscussionNote() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#add-note-to-existing-epic-thread

type AddGPGKeyOptions added in v0.116.0 

type AddGPGKeyOptions struct {
	Key *string `url:"key,omitempty" json:"key,omitempty"`
}

AddGPGKeyOptions represents the available AddGPGKey() options.

GitLab API docs: https://docs.gitlab.com/api/user_keys/#add-a-gpg-key

type AddGroupBadgeOptions added in v0.116.0 

type AddGroupBadgeOptions struct {
	LinkURL  *string `url:"link_url,omitempty" json:"link_url,omitempty"`
	ImageURL *string `url:"image_url,omitempty" json:"image_url,omitempty"`
	Name     *string `url:"name,omitempty" json:"name,omitempty"`
}

AddGroupBadgeOptions represents the available AddGroupBadge() options.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#add-a-badge-to-a-group

type AddGroupClusterOptions added in v0.116.0 

type AddGroupClusterOptions struct {
	Name                *string                            `url:"name,omitempty" json:"name,omitempty"`
	Domain              *string                            `url:"domain,omitempty" json:"domain,omitempty"`
	ManagementProjectID *string                            `url:"management_project_id,omitempty" json:"management_project_id,omitempty"`
	Enabled             *bool                              `url:"enabled,omitempty" json:"enabled,omitempty"`
	Managed             *bool                              `url:"managed,omitempty" json:"managed,omitempty"`
	EnvironmentScope    *string                            `url:"environment_scope,omitempty" json:"environment_scope,omitempty"`
	PlatformKubernetes  *AddGroupPlatformKubernetesOptions `url:"platform_kubernetes_attributes,omitempty" json:"platform_kubernetes_attributes,omitempty"`
}

AddGroupClusterOptions represents the available AddCluster() options. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/group_clusters/#add-existing-cluster-to-group

type AddGroupHookOptions added in v0.116.0 

type AddGroupHookOptions struct {
	URL                       *string              `url:"url,omitempty" json:"url,omitempty"`
	Name                      *string              `url:"name,omitempty" json:"name,omitempty"`
	Description               *string              `url:"description,omitempty" json:"description,omitempty"`
	PushEvents                *bool                `url:"push_events,omitempty"  json:"push_events,omitempty"`
	PushEventsBranchFilter    *string              `url:"push_events_branch_filter,omitempty"  json:"push_events_branch_filter,omitempty"`
	BranchFilterStrategy      *string              `url:"branch_filter_strategy,omitempty"  json:"branch_filter_strategy,omitempty"`
	IssuesEvents              *bool                `url:"issues_events,omitempty"  json:"issues_events,omitempty"`
	ConfidentialIssuesEvents  *bool                `url:"confidential_issues_events,omitempty"  json:"confidential_issues_events,omitempty"`
	MergeRequestsEvents       *bool                `url:"merge_requests_events,omitempty"  json:"merge_requests_events,omitempty"`
	TagPushEvents             *bool                `url:"tag_push_events,omitempty"  json:"tag_push_events,omitempty"`
	NoteEvents                *bool                `url:"note_events,omitempty"  json:"note_events,omitempty"`
	ConfidentialNoteEvents    *bool                `url:"confidential_note_events,omitempty"  json:"confidential_note_events,omitempty"`
	JobEvents                 *bool                `url:"job_events,omitempty"  json:"job_events,omitempty"`
	PipelineEvents            *bool                `url:"pipeline_events,omitempty"  json:"pipeline_events,omitempty"`
	ProjectEvents             *bool                `url:"project_events,omitempty"  json:"project_events,omitempty"`
	WikiPageEvents            *bool                `url:"wiki_page_events,omitempty"  json:"wiki_page_events,omitempty"`
	DeploymentEvents          *bool                `url:"deployment_events,omitempty" json:"deployment_events,omitempty"`
	FeatureFlagEvents         *bool                `url:"feature_flag_events,omitempty" json:"feature_flag_events,omitempty"`
	ReleasesEvents            *bool                `url:"releases_events,omitempty" json:"releases_events,omitempty"`
	MilestoneEvents           *bool                `url:"milestone_events,omitempty" json:"milestone_events,omitempty"`
	SubGroupEvents            *bool                `url:"subgroup_events,omitempty" json:"subgroup_events,omitempty"`
	EmojiEvents               *bool                `url:"emoji_events,omitempty" json:"emoji_events,omitempty"`
	MemberEvents              *bool                `url:"member_events,omitempty" json:"member_events,omitempty"`
	VulnerabilityEvents       *bool                `url:"vulnerability_events,omitempty" json:"vulnerability_events,omitempty"`
	EnableSSLVerification     *bool                `url:"enable_ssl_verification,omitempty"  json:"enable_ssl_verification,omitempty"`
	Token                     *string              `url:"token,omitempty" json:"token,omitempty"`
	ResourceAccessTokenEvents *bool                `url:"resource_access_token_events,omitempty" json:"resource_access_token_events,omitempty"`
	CustomWebhookTemplate     *string              `url:"custom_webhook_template,omitempty" json:"custom_webhook_template,omitempty"`
	CustomHeaders             *[]*HookCustomHeader `url:"custom_headers,omitempty" json:"custom_headers,omitempty"`
}

AddGroupHookOptions represents the available AddGroupHook() options.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#add-a-group-hook

type AddGroupLDAPLinkOptions added in v0.116.0 

type AddGroupLDAPLinkOptions struct {
	CN           *string           `url:"cn,omitempty" json:"cn,omitempty"`
	Filter       *string           `url:"filter,omitempty" json:"filter,omitempty"`
	GroupAccess  *AccessLevelValue `url:"group_access,omitempty" json:"group_access,omitempty"`
	Provider     *string           `url:"provider,omitempty" json:"provider,omitempty"`
	MemberRoleID *int64            `url:"member_role_id,omitempty" json:"member_role_id,omitempty"`
}

AddGroupLDAPLinkOptions represents the available AddGroupLDAPLink() options.

GitLab API docs: https://docs.gitlab.com/api/group_ldap_links/#add-an-ldap-group-link-with-cn-or-filter

type AddGroupMemberOptions 

type AddGroupMemberOptions struct {
	UserID       *int64            `url:"user_id,omitempty" json:"user_id,omitempty"`
	Username     *string           `url:"username,omitempty" json:"username,omitempty"`
	AccessLevel  *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	ExpiresAt    *string           `url:"expires_at,omitempty" json:"expires_at"`
	MemberRoleID *int64            `url:"member_role_id,omitempty" json:"member_role_id,omitempty"`
}

AddGroupMemberOptions represents the available AddGroupMember() options.

GitLab API docs: https://docs.gitlab.com/api/members/#add-a-member-to-a-group-or-project

type AddGroupPlatformKubernetesOptions added in v0.116.0 

type AddGroupPlatformKubernetesOptions struct {
	APIURL            *string `url:"api_url,omitempty" json:"api_url,omitempty"`
	Token             *string `url:"token,omitempty" json:"token,omitempty"`
	CaCert            *string `url:"ca_cert,omitempty" json:"ca_cert,omitempty"`
	Namespace         *string `url:"namespace,omitempty" json:"namespace,omitempty"`
	AuthorizationType *string `url:"authorization_type,omitempty" json:"authorization_type,omitempty"`
}

AddGroupPlatformKubernetesOptions represents the available PlatformKubernetes options for adding. Deprecated: in GitLab 14.5, to be removed in 19.0

type AddGroupPushRuleOptions added in v0.116.0 

type AddGroupPushRuleOptions struct {
	AuthorEmailRegex           *string `url:"author_email_regex,omitempty" json:"author_email_regex,omitempty"`
	BranchNameRegex            *string `url:"branch_name_regex,omitempty" json:"branch_name_regex,omitempty"`
	CommitCommitterCheck       *bool   `url:"commit_committer_check,omitempty" json:"commit_committer_check,omitempty"`
	CommitCommitterNameCheck   *bool   `url:"commit_committer_name_check,omitempty" json:"commit_committer_name_check,omitempty"`
	CommitMessageNegativeRegex *string `url:"commit_message_negative_regex,omitempty" json:"commit_message_negative_regex,omitempty"`
	CommitMessageRegex         *string `url:"commit_message_regex,omitempty" json:"commit_message_regex,omitempty"`
	DenyDeleteTag              *bool   `url:"deny_delete_tag,omitempty" json:"deny_delete_tag,omitempty"`
	FileNameRegex              *string `url:"file_name_regex,omitempty" json:"file_name_regex,omitempty"`
	MaxFileSize                *int64  `url:"max_file_size,omitempty" json:"max_file_size,omitempty"`
	MemberCheck                *bool   `url:"member_check,omitempty" json:"member_check,omitempty"`
	PreventSecrets             *bool   `url:"prevent_secrets,omitempty" json:"prevent_secrets,omitempty"`
	RejectUnsignedCommits      *bool   `url:"reject_unsigned_commits,omitempty" json:"reject_unsigned_commits,omitempty"`
	RejectNonDCOCommits        *bool   `url:"reject_non_dco_commits,omitempty" json:"reject_non_dco_commits,omitempty"`
}

AddGroupPushRuleOptions represents the available AddGroupPushRule() options.

GitLab API docs: https://docs.gitlab.com/api/group_push_rules/#add-push-rules-to-a-group

type AddGroupSAMLLinkOptions added in v0.116.0 

type AddGroupSAMLLinkOptions struct {
	SAMLGroupName *string           `url:"saml_group_name,omitempty" json:"saml_group_name,omitempty"`
	AccessLevel   *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	MemberRoleID  *int64            `url:"member_role_id,omitempty" json:"member_role_id,omitempty"`
	Provider      *string           `url:"provider,omitempty" json:"provider,omitempty"`
}

AddGroupSAMLLinkOptions represents the available AddGroupSAMLLink() options.

GitLab API docs: https://docs.gitlab.com/api/saml/#add-a-saml-group-link

type AddGroupToJobTokenAllowlistOptions added in v0.116.0 

type AddGroupToJobTokenAllowlistOptions struct {
	TargetGroupID *int64 `url:"target_group_id,omitempty" json:"target_group_id,omitempty"`
}

AddGroupToJobTokenAllowlistOptions represents the available AddGroupToJobTokenAllowlist() options.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#add-a-group-to-a-cicd-job-token-allowlist

type AddHookOptions 

type AddHookOptions struct {
	URL                    *string `url:"url,omitempty" json:"url,omitempty"`
	Token                  *string `url:"token,omitempty" json:"token,omitempty"`
	PushEvents             *bool   `url:"push_events,omitempty" json:"push_events,omitempty"`
	TagPushEvents          *bool   `url:"tag_push_events,omitempty" json:"tag_push_events,omitempty"`
	MergeRequestsEvents    *bool   `url:"merge_requests_events,omitempty" json:"merge_requests_events,omitempty"`
	RepositoryUpdateEvents *bool   `url:"repository_update_events,omitempty" json:"repository_update_events,omitempty"`
	EnableSSLVerification  *bool   `url:"enable_ssl_verification,omitempty" json:"enable_ssl_verification,omitempty"`
}

AddHookOptions represents the available AddHook() options.

GitLab API docs: https://docs.gitlab.com/api/system_hooks/#add-new-system-hook

type AddInstanceDeployKeyOptions added in v0.130.0 

type AddInstanceDeployKeyOptions struct {
	Key       *string    `url:"key,omitempty" json:"key,omitempty"`
	Title     *string    `url:"title,omitempty" json:"title,omitempty"`
	ExpiresAt *time.Time `url:"expires_at,omitempty" json:"expires_at,omitempty"`
}

AddInstanceDeployKeyOptions represents the available AddInstanceDeployKey() options.

GitLab API docs: https://docs.gitlab.com/api/deploy_keys/#add-deploy-key

type AddIssueDiscussionNoteOptions added in v0.11.2 

type AddIssueDiscussionNoteOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
}

AddIssueDiscussionNoteOptions represents the available AddIssueDiscussionNote() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#add-note-to-existing-issue-thread

type AddLicenseOptions added in v0.11.4 

type AddLicenseOptions struct {
	License *string `url:"license" json:"license"`
}

AddLicenseOptions represents the available AddLicense() options.

https://docs.gitlab.com/api/license/#add-a-new-license

type AddMergeRequestDiscussionNoteOptions added in v0.11.2 

type AddMergeRequestDiscussionNoteOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
}

AddMergeRequestDiscussionNoteOptions represents the available AddMergeRequestDiscussionNote() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#add-note-to-existing-merge-request-thread

type AddMergeRequestToMergeTrainOptions added in v0.116.0 

type AddMergeRequestToMergeTrainOptions struct {
	AutoMerge *bool   `url:"auto_merge,omitempty" json:"auto_merge,omitempty"`
	SHA       *string `url:"sha,omitempty" json:"sha,omitempty"`
	Squash    *bool   `url:"squash,omitempty" json:"squash,omitempty"`

	// Deprecated: in 17.11, use AutoMerge instead
	WhenPipelineSucceeds *bool `url:"when_pipeline_succeeds,omitempty" json:"when_pipeline_succeeds,omitempty"`
}

AddMergeRequestToMergeTrainOptions represents the available AddMergeRequestToMergeTrain() options.

GitLab API docs: https://docs.gitlab.com/api/merge_trains/#add-a-merge-request-to-a-merge-train

type AddPipelineTriggerOptions added in v0.6.0 

type AddPipelineTriggerOptions struct {
	Description *string `url:"description,omitempty" json:"description,omitempty"`
}

AddPipelineTriggerOptions represents the available AddPipelineTrigger() options.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/#create-a-trigger-token

type AddPlatformKubernetesOptions added in v0.116.0 

type AddPlatformKubernetesOptions struct {
	APIURL            *string `url:"api_url,omitempty" json:"api_url,omitempty"`
	Token             *string `url:"token,omitempty" json:"token,omitempty"`
	CaCert            *string `url:"ca_cert,omitempty" json:"ca_cert,omitempty"`
	Namespace         *string `url:"namespace,omitempty" json:"namespace,omitempty"`
	AuthorizationType *string `url:"authorization_type,omitempty" json:"authorization_type,omitempty"`
}

AddPlatformKubernetesOptions represents the available PlatformKubernetes options for adding. Deprecated: in GitLab 14.5, to be removed in 19.0

type AddProjectBadgeOptions added in v0.11.1 

type AddProjectBadgeOptions struct {
	LinkURL  *string `url:"link_url,omitempty" json:"link_url,omitempty"`
	ImageURL *string `url:"image_url,omitempty" json:"image_url,omitempty"`
	Name     *string `url:"name,omitempty" json:"name,omitempty"`
}

AddProjectBadgeOptions represents the available AddProjectBadge() options.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#add-a-badge-to-a-project

type AddProjectHookOptions 

type AddProjectHookOptions struct {
	Name                      *string              `url:"name,omitempty" json:"name,omitempty"`
	Description               *string              `url:"description,omitempty" json:"description,omitempty"`
	ConfidentialIssuesEvents  *bool                `url:"confidential_issues_events,omitempty" json:"confidential_issues_events,omitempty"`
	ConfidentialNoteEvents    *bool                `url:"confidential_note_events,omitempty" json:"confidential_note_events,omitempty"`
	DeploymentEvents          *bool                `url:"deployment_events,omitempty" json:"deployment_events,omitempty"`
	EnableSSLVerification     *bool                `url:"enable_ssl_verification,omitempty" json:"enable_ssl_verification,omitempty"`
	IssuesEvents              *bool                `url:"issues_events,omitempty" json:"issues_events,omitempty"`
	JobEvents                 *bool                `url:"job_events,omitempty" json:"job_events,omitempty"`
	MergeRequestsEvents       *bool                `url:"merge_requests_events,omitempty" json:"merge_requests_events,omitempty"`
	NoteEvents                *bool                `url:"note_events,omitempty" json:"note_events,omitempty"`
	PipelineEvents            *bool                `url:"pipeline_events,omitempty" json:"pipeline_events,omitempty"`
	PushEvents                *bool                `url:"push_events,omitempty" json:"push_events,omitempty"`
	PushEventsBranchFilter    *string              `url:"push_events_branch_filter,omitempty" json:"push_events_branch_filter,omitempty"`
	ReleasesEvents            *bool                `url:"releases_events,omitempty" json:"releases_events,omitempty"`
	EmojiEvents               *bool                `url:"emoji_events,omitempty" json:"emoji_events,omitempty"`
	TagPushEvents             *bool                `url:"tag_push_events,omitempty" json:"tag_push_events,omitempty"`
	Token                     *string              `url:"token,omitempty" json:"token,omitempty"`
	URL                       *string              `url:"url,omitempty" json:"url,omitempty"`
	WikiPageEvents            *bool                `url:"wiki_page_events,omitempty" json:"wiki_page_events,omitempty"`
	ResourceAccessTokenEvents *bool                `url:"resource_access_token_events,omitempty" json:"resource_access_token_events,omitempty"`
	CustomWebhookTemplate     *string              `url:"custom_webhook_template,omitempty" json:"custom_webhook_template,omitempty"`
	CustomHeaders             *[]*HookCustomHeader `url:"custom_headers,omitempty" json:"custom_headers,omitempty"`
	VulnerabilityEvents       *bool                `url:"vulnerability_events,omitempty" json:"vulnerability_events,omitempty"`
	BranchFilterStrategy      *string              `url:"branch_filter_strategy,omitempty" json:"branch_filter_strategy,omitempty"`
}

AddProjectHookOptions represents the available AddProjectHook() options.

GitLab API docs: https://docs.gitlab.com/api/project_webhooks/#add-a-webhook-to-a-project

type AddProjectMemberOptions 

type AddProjectMemberOptions struct {
	UserID       any               `url:"user_id,omitempty" json:"user_id,omitempty"`
	Username     *string           `url:"username,omitempty" json:"username,omitempty"`
	AccessLevel  *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	ExpiresAt    *string           `url:"expires_at,omitempty" json:"expires_at"`
	MemberRoleID *int64            `url:"member_role_id,omitempty" json:"member_role_id,omitempty"`
}

AddProjectMemberOptions represents the available AddProjectMember() options.

GitLab API docs: https://docs.gitlab.com/api/members/#add-a-member-to-a-group-or-project

type AddProjectMirrorOptions added in v0.116.0 

type AddProjectMirrorOptions struct {
	URL                   *string `url:"url,omitempty" json:"url,omitempty"`
	Enabled               *bool   `url:"enabled,omitempty" json:"enabled,omitempty"`
	KeepDivergentRefs     *bool   `url:"keep_divergent_refs,omitempty" json:"keep_divergent_refs,omitempty"`
	OnlyProtectedBranches *bool   `url:"only_protected_branches,omitempty" json:"only_protected_branches,omitempty"`
	MirrorBranchRegex     *string `url:"mirror_branch_regex,omitempty" json:"mirror_branch_regex,omitempty"`
	AuthMethod            *string `url:"auth_method,omitempty" json:"auth_method,omitempty"`
}

AddProjectMirrorOptions contains the properties requires to create a new project mirror.

GitLab API docs: https://docs.gitlab.com/api/remote_mirrors/#create-a-push-mirror

type AddProjectPushRuleOptions added in v0.116.0 

type AddProjectPushRuleOptions struct {
	AuthorEmailRegex           *string `url:"author_email_regex,omitempty" json:"author_email_regex,omitempty"`
	BranchNameRegex            *string `url:"branch_name_regex,omitempty" json:"branch_name_regex,omitempty"`
	CommitCommitterCheck       *bool   `url:"commit_committer_check,omitempty" json:"commit_committer_check,omitempty"`
	CommitCommitterNameCheck   *bool   `url:"commit_committer_name_check,omitempty" json:"commit_committer_name_check,omitempty"`
	CommitMessageNegativeRegex *string `url:"commit_message_negative_regex,omitempty" json:"commit_message_negative_regex,omitempty"`
	CommitMessageRegex         *string `url:"commit_message_regex,omitempty" json:"commit_message_regex,omitempty"`
	DenyDeleteTag              *bool   `url:"deny_delete_tag,omitempty" json:"deny_delete_tag,omitempty"`
	FileNameRegex              *string `url:"file_name_regex,omitempty" json:"file_name_regex,omitempty"`
	MaxFileSize                *int64  `url:"max_file_size,omitempty" json:"max_file_size,omitempty"`
	MemberCheck                *bool   `url:"member_check,omitempty" json:"member_check,omitempty"`
	PreventSecrets             *bool   `url:"prevent_secrets,omitempty" json:"prevent_secrets,omitempty"`
	RejectUnsignedCommits      *bool   `url:"reject_unsigned_commits,omitempty" json:"reject_unsigned_commits,omitempty"`
	RejectNonDCOCommits        *bool   `url:"reject_non_dco_commits,omitempty" json:"reject_non_dco_commits,omitempty"`
}

AddProjectPushRuleOptions represents the available AddProjectPushRule() options.

GitLab API docs: https://docs.gitlab.com/api/project_push_rules/#add-a-project-push-rule

type AddSSHKeyOptions 

type AddSSHKeyOptions struct {
	Title     *string  `url:"title,omitempty" json:"title,omitempty"`
	Key       *string  `url:"key,omitempty" json:"key,omitempty"`
	ExpiresAt *ISOTime `url:"expires_at,omitempty" json:"expires_at,omitempty"`
	UsageType *string  `url:"usage_type,omitempty" json:"usage_type,omitempty"`
}

AddSSHKeyOptions represents the available AddSSHKey() options.

GitLab API docs: https://docs.gitlab.com/api/user_keys/#add-an-ssh-key

type AddSnippetDiscussionNoteOptions added in v0.11.2 

type AddSnippetDiscussionNoteOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
}

AddSnippetDiscussionNoteOptions represents the available AddSnippetDiscussionNote() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#add-note-to-existing-snippet-thread

type AddSpentTimeOptions added in v0.4.0 

type AddSpentTimeOptions struct {
	Duration *string `url:"duration,omitempty" json:"duration,omitempty"`
	Summary  *string `url:"summary,omitempty" json:"summary,omitempty"`
}

AddSpentTimeOptions represents the available AddSpentTime() options.

GitLab docs: https://docs.gitlab.com/api/issues/#add-spent-time-for-an-issue

type AdminCompliancePolicySettings added in v1.6.0 

type AdminCompliancePolicySettings struct {
	CSPNamespaceID *int64 `json:"csp_namespace_id"`
}

AdminCompliancePolicySettings represents the GitLab admin compliance policy settings.

GitLab API docs: https://docs.gitlab.com/api/compliance_policy_settings/

func (AdminCompliancePolicySettings) String added in v1.6.0 

func (s AdminCompliancePolicySettings) String() string

type AdminCompliancePolicySettingsService added in v1.6.0 

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

AdminCompliancePolicySettingsService handles communication with the admin compliance policy settings related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/compliance_policy_settings/

func (*AdminCompliancePolicySettingsService) GetCompliancePolicySettings added in v1.6.0 

func (s *AdminCompliancePolicySettingsService) GetCompliancePolicySettings(options ...RequestOptionFunc) (*AdminCompliancePolicySettings, *Response, error)

func (*AdminCompliancePolicySettingsService) UpdateCompliancePolicySettings added in v1.6.0 

func (s *AdminCompliancePolicySettingsService) UpdateCompliancePolicySettings(opt *UpdateAdminCompliancePolicySettingsOptions, options ...RequestOptionFunc) (*AdminCompliancePolicySettings, *Response, error)

type AdminCompliancePolicySettingsServiceInterface added in v1.6.0 

type AdminCompliancePolicySettingsServiceInterface interface {
	// GetCompliancePolicySettings gets the current security policy settings for the GitLab instance.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/compliance_policy_settings/#get-security-policy-settings
	GetCompliancePolicySettings(options ...RequestOptionFunc) (*AdminCompliancePolicySettings, *Response, error)

	// UpdateCompliancePolicySettings updates the security policy settings for the GitLab instance.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/compliance_policy_settings/#update-security-policy-settings
	UpdateCompliancePolicySettings(opt *UpdateAdminCompliancePolicySettingsOptions, options ...RequestOptionFunc) (*AdminCompliancePolicySettings, *Response, error)
}

type Agent added in v0.116.0 

type Agent struct {
	ID              int64         `json:"id"`
	Name            string        `json:"name"`
	CreatedAt       *time.Time    `json:"created_at"`
	CreatedByUserID int64         `json:"created_by_user_id"`
	ConfigProject   ConfigProject `json:"config_project"`
}

Agent represents a GitLab agent for Kubernetes.

GitLab API docs: https://docs.gitlab.com/api/cluster_agents/

func (Agent) String added in v0.116.0 

func (a Agent) String() string

type AgentToken added in v0.116.0 

type AgentToken struct {
	ID              int64      `json:"id"`
	Name            string     `json:"name"`
	Description     string     `json:"description"`
	AgentID         int64      `json:"agent_id"`
	Status          string     `json:"status"`
	CreatedAt       *time.Time `json:"created_at"`
	CreatedByUserID int64      `json:"created_by_user_id"`
	LastUsedAt      *time.Time `json:"last_used_at"`
	Token           string     `json:"token"`
}

AgentToken represents a GitLab agent token.

GitLab API docs: https://docs.gitlab.com/api/cluster_agents/#list-tokens-for-an-agent

func (AgentToken) String added in v0.116.0 

func (a AgentToken) String() string

type AlertManagementService added in v0.128.0 

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

AlertManagementService handles communication with the alert management related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/alert_management_alerts/

func (*AlertManagementService) DeleteMetricImage added in v0.128.0 

func (s *AlertManagementService) DeleteMetricImage(pid any, alertIID int64, id int64, options ...RequestOptionFunc) (*Response, error)

func (*AlertManagementService) ListMetricImages added in v0.128.0 

func (s *AlertManagementService) ListMetricImages(pid any, alertIID int64, opt *ListMetricImagesOptions, options ...RequestOptionFunc) ([]*MetricImage, *Response, error)

func (*AlertManagementService) UpdateMetricImage added in v0.128.0 

func (s *AlertManagementService) UpdateMetricImage(pid any, alertIID int64, id int64, opt *UpdateMetricImageOptions, options ...RequestOptionFunc) (*MetricImage, *Response, error)

func (*AlertManagementService) UploadMetricImage added in v0.128.0 

func (s *AlertManagementService) UploadMetricImage(pid any, alertIID int64, content io.Reader, filename string, opt *UploadMetricImageOptions, options ...RequestOptionFunc) (*MetricImage, *Response, error)

type AlertManagementServiceInterface added in v0.128.0 

type AlertManagementServiceInterface interface {
	// UploadMetricImage uploads a metric image to a project alert.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/alert_management_alerts/#upload-metric-image
	UploadMetricImage(pid any, alertIID int64, content io.Reader, filename string, opt *UploadMetricImageOptions, options ...RequestOptionFunc) (*MetricImage, *Response, error)

	// ListMetricImages lists all the metric images for a project alert.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/alert_management_alerts/#list-all-metric-images
	ListMetricImages(pid any, alertIID int64, opt *ListMetricImagesOptions, options ...RequestOptionFunc) ([]*MetricImage, *Response, error)

	// UpdateMetricImage updates a metric image for a project alert.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/alert_management_alerts/#update-a-metric-image
	UpdateMetricImage(pid any, alertIID int64, id int64, opt *UpdateMetricImageOptions, options ...RequestOptionFunc) (*MetricImage, *Response, error)

	// DeleteMetricImage deletes a metric image for a project alert.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/alert_management_alerts/#delete-a-metric-image
	DeleteMetricImage(pid any, alertIID int64, id int64, options ...RequestOptionFunc) (*Response, error)
}

type Appearance added in v0.116.0 

type Appearance struct {
	Title                       string `json:"title"`
	Description                 string `json:"description"`
	PWAName                     string `json:"pwa_name"`
	PWAShortName                string `json:"pwa_short_name"`
	PWADescription              string `json:"pwa_description"`
	PWAIcon                     string `json:"pwa_icon"`
	Favicon                     string `json:"favicon"`
	MemberGuidelines            string `json:"member_guidelines"`
	NewProjectGuidelines        string `json:"new_project_guidelines"`
	ProfileImageGuidelines      string `json:"profile_image_guidelines"`
	HeaderMessage               string `json:"header_message"`
	FooterMessage               string `json:"footer_message"`
	MessageBackgroundColor      string `json:"message_background_color"`
	MessageFontColor            string `json:"message_font_color"`
	EmailHeaderAndFooterEnabled bool   `json:"email_header_and_footer_enabled"`
}

Appearance represents a GitLab appearance.

GitLab API docs: https://docs.gitlab.com/api/appearance/

type AppearanceService added in v0.116.0 

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

AppearanceService handles communication with appearance of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/appearance/

func (*AppearanceService) ChangeAppearance added in v0.116.0 

func (s *AppearanceService) ChangeAppearance(opt *ChangeAppearanceOptions, options ...RequestOptionFunc) (*Appearance, *Response, error)

func (*AppearanceService) GetAppearance added in v0.116.0 

func (s *AppearanceService) GetAppearance(options ...RequestOptionFunc) (*Appearance, *Response, error)

type AppearanceServiceInterface added in v0.126.0 

type AppearanceServiceInterface interface {
	// GetAppearance gets the current appearance configuration of the GitLab instance.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/appearance/#get-details-on-current-application-appearance
	GetAppearance(options ...RequestOptionFunc) (*Appearance, *Response, error)

	// ChangeAppearance changes the appearance configuration.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/appearance/#update-application-appearance
	ChangeAppearance(opt *ChangeAppearanceOptions, options ...RequestOptionFunc) (*Appearance, *Response, error)
}

type Application added in v0.116.0 

type Application struct {
	ID              int64  `json:"id"`
	ApplicationID   string `json:"application_id"`
	ApplicationName string `json:"application_name"`
	Secret          string `json:"secret"`
	CallbackURL     string `json:"callback_url"`
	Confidential    bool   `json:"confidential"`
}

Application represents a GitLab application

type ApplicationStatistics added in v0.128.0 

type ApplicationStatistics struct {
	Forks         int64 `url:"forks" json:"forks"`
	Issues        int64 `url:"issues" json:"issues"`
	MergeRequests int64 `url:"merge_requests" json:"merge_requests"`
	Notes         int64 `url:"notes" json:"notes"`
	Snippets      int64 `url:"snippets" json:"snippets"`
	SSHKeys       int64 `url:"ssh_keys" json:"ssh_keys"`
	Milestones    int64 `url:"milestones" json:"milestones"`
	Users         int64 `url:"users" json:"users"`
	Groups        int64 `url:"groups" json:"groups"`
	Projects      int64 `url:"projects" json:"projects"`
	ActiveUsers   int64 `url:"active_users" json:"active_users"`
}

ApplicationStatistics represents application statistics.

GitLab API docs: https://docs.gitlab.com/api/statistics/

type ApplicationStatisticsService added in v0.128.0 

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

ApplicationStatisticsService handles communication with the application statistics related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/statistics/

func (*ApplicationStatisticsService) GetApplicationStatistics added in v0.128.0 

func (s *ApplicationStatisticsService) GetApplicationStatistics(options ...RequestOptionFunc) (*ApplicationStatistics, *Response, error)

type ApplicationStatisticsServiceInterface added in v0.128.0 

type ApplicationStatisticsServiceInterface interface {
	// GetApplicationStatistics gets details on the current application statistics.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/statistics/#get-details-on-current-application-statistics
	GetApplicationStatistics(options ...RequestOptionFunc) (*ApplicationStatistics, *Response, error)
}

type ApplicationsService added in v0.116.0 

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

ApplicationsService handles communication with administrables applications of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/applications/

func (*ApplicationsService) CreateApplication added in v0.116.0 

func (s *ApplicationsService) CreateApplication(opt *CreateApplicationOptions, options ...RequestOptionFunc) (*Application, *Response, error)

func (*ApplicationsService) DeleteApplication added in v0.116.0 

func (s *ApplicationsService) DeleteApplication(application int64, options ...RequestOptionFunc) (*Response, error)

func (*ApplicationsService) ListApplications added in v0.116.0 

func (s *ApplicationsService) ListApplications(opt *ListApplicationsOptions, options ...RequestOptionFunc) ([]*Application, *Response, error)

type ApplicationsServiceInterface added in v0.126.0 

type ApplicationsServiceInterface interface {
	// CreateApplication creates a new application owned by the authenticated user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/applications/#create-an-application
	CreateApplication(opt *CreateApplicationOptions, options ...RequestOptionFunc) (*Application, *Response, error)

	// ListApplications get a list of administrables applications by the authenticated user
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/applications/#list-all-applications
	ListApplications(opt *ListApplicationsOptions, options ...RequestOptionFunc) ([]*Application, *Response, error)

	// DeleteApplication removes a specific application.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/applications/#delete-an-application
	DeleteApplication(application int64, options ...RequestOptionFunc) (*Response, error)
}

type ApproveAccessRequestOptions added in v0.11.1 

type ApproveAccessRequestOptions struct {
	AccessLevel *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
}

ApproveAccessRequestOptions represents the available ApproveProjectAccessRequest() and ApproveGroupAccessRequest() options.

GitLab API docs: https://docs.gitlab.com/api/access_requests/#approve-an-access-request

type ApproveMergeRequestOptions added in v0.10.0 

type ApproveMergeRequestOptions struct {
	SHA *string `url:"sha,omitempty" json:"sha,omitempty"`
}

ApproveMergeRequestOptions represents the available ApproveMergeRequest() options.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#approve-merge-request

type ApproveOrRejectProjectDeploymentOptions added in v0.116.0 

type ApproveOrRejectProjectDeploymentOptions struct {
	Status        *DeploymentApprovalStatus `url:"status,omitempty" json:"status,omitempty"`
	Comment       *string                   `url:"comment,omitempty" json:"comment,omitempty"`
	RepresentedAs *string                   `url:"represented_as,omitempty" json:"represented_as,omitempty"`
}

ApproveOrRejectProjectDeploymentOptions represents the available ApproveOrRejectProjectDeployment() options.

GitLab API docs: https://docs.gitlab.com/api/deployments/#approve-or-reject-a-blocked-deployment

type ApproverIDsValue added in v0.116.0 

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

ApproverIDsValue represents an approver ID value within GitLab.

func ApproverIDs added in v0.116.0 

func ApproverIDs(v any) *ApproverIDsValue

ApproverIDs is a helper routine that creates a new ApproverIDsValue.

func (*ApproverIDsValue) EncodeValues added in v0.116.0 

func (a *ApproverIDsValue) EncodeValues(key string, v *url.Values) error

EncodeValues implements the query.Encoder interface.

func (ApproverIDsValue) MarshalJSON added in v0.116.0 

func (a ApproverIDsValue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*ApproverIDsValue) UnmarshalJSON added in v0.116.0 

func (a *ApproverIDsValue) UnmarshalJSON(bytes []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type ArchiveOptions 

type ArchiveOptions struct {
	Format *string `url:"-" json:"-"`
	Path   *string `url:"path,omitempty" json:"path,omitempty"`
	SHA    *string `url:"sha,omitempty" json:"sha,omitempty"`
}

ArchiveOptions represents the available Archive() options.

GitLab API docs: https://docs.gitlab.com/api/repositories/#get-file-archive

type AssigneeIDValue added in v0.116.0 

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

AssigneeIDValue represents an assignee ID value within GitLab.

func AssigneeID added in v0.116.0 

func AssigneeID(v any) *AssigneeIDValue

AssigneeID is a helper routine that creates a new AssigneeIDValue.

func (*AssigneeIDValue) EncodeValues added in v0.116.0 

func (a *AssigneeIDValue) EncodeValues(key string, v *url.Values) error

EncodeValues implements the query.Encoder interface.

func (AssigneeIDValue) MarshalJSON added in v0.116.0 

func (a AssigneeIDValue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*AssigneeIDValue) UnmarshalJSON added in v0.116.0 

func (a *AssigneeIDValue) UnmarshalJSON(bytes []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type Attestation added in v1.4.0 

type Attestation struct {
	ID            int64      `json:"id"`
	IID           int64      `json:"iid"`
	ProjectID     int64      `json:"project_id"`
	BuildID       int64      `json:"build_id"`
	Status        string     `json:"status"`
	CreatedAt     *time.Time `json:"created_at"`
	UpdatedAt     *time.Time `json:"updated_at"`
	ExpireAt      *time.Time `json:"expire_at"`
	PredicateKind string     `json:"predicate_kind"`
	PredicateType string     `json:"predicate_type"`
	SubjectDigest string     `json:"subject_digest"`
	DownloadURL   string     `json:"download_url"`
}

type AttestationsService added in v1.4.0 

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

AttestationsService handles communication with the keys related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/attestations

func (*AttestationsService) DownloadAttestation added in v1.4.0 

func (s *AttestationsService) DownloadAttestation(pid any, attestationIID int64, options ...RequestOptionFunc) ([]byte, *Response, error)

func (*AttestationsService) ListAttestations added in v1.4.0 

func (s *AttestationsService) ListAttestations(pid any, subjectDigest string, options ...RequestOptionFunc) ([]*Attestation, *Response, error)

type AttestationsServiceInterface added in v1.4.0 

type AttestationsServiceInterface interface {
	// ListAttestations gets a list of all attestations
	//
	// GitLab API docs: https://docs.gitlab.com/api/attestations/#list-all-attestations
	ListAttestations(pid any, subjectDigest string, options ...RequestOptionFunc) ([]*Attestation, *Response, error)

	// DownloadAttestation
	//
	// GitLab API docs: https://docs.gitlab.com/api/attestations/#download-an-attestation
	DownloadAttestation(pid any, attestationIID int64, options ...RequestOptionFunc) ([]byte, *Response, error)
}

type AuditEvent added in v0.116.0 

type AuditEvent struct {
	ID         int64             `json:"id"`
	AuthorID   int64             `json:"author_id"`
	EntityID   int64             `json:"entity_id"`
	EntityType string            `json:"entity_type"`
	EventName  string            `json:"event_name"`
	Details    AuditEventDetails `json:"details"`
	CreatedAt  *time.Time        `json:"created_at"`
	EventType  string            `json:"event_type"`
}

AuditEvent represents an audit event for a group, a project or the instance.

GitLab API docs: https://docs.gitlab.com/api/audit_events/

type AuditEventDetails added in v0.116.0 

type AuditEventDetails struct {
	With          string `json:"with"`
	Add           string `json:"add"`
	As            string `json:"as"`
	Change        string `json:"change"`
	From          string `json:"from"`
	To            string `json:"to"`
	Remove        string `json:"remove"`
	CustomMessage string `json:"custom_message"`
	AuthorName    string `json:"author_name"`
	AuthorEmail   string `json:"author_email"`
	AuthorClass   string `json:"author_class"`
	TargetID      any    `json:"target_id"`
	TargetType    string `json:"target_type"`
	TargetDetails string `json:"target_details"`
	IPAddress     string `json:"ip_address"`
	EntityPath    string `json:"entity_path"`
	FailedLogin   string `json:"failed_login"`
	EventName     string `json:"event_name"`
}

AuditEventDetails represents the details portion of an audit event for a group, a project or the instance. The exact fields that are returned for an audit event depend on the action being recorded.

GitLab API docs: https://docs.gitlab.com/api/audit_events/

type AuditEventsService added in v0.116.0 

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

AuditEventsService handles communication with the project/group/instance audit event related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/audit_events/

func (*AuditEventsService) GetGroupAuditEvent added in v0.116.0 

func (s *AuditEventsService) GetGroupAuditEvent(gid any, event int64, options ...RequestOptionFunc) (*AuditEvent, *Response, error)

func (*AuditEventsService) GetInstanceAuditEvent added in v0.116.0 

func (s *AuditEventsService) GetInstanceAuditEvent(event int64, options ...RequestOptionFunc) (*AuditEvent, *Response, error)

func (*AuditEventsService) GetProjectAuditEvent added in v0.116.0 

func (s *AuditEventsService) GetProjectAuditEvent(pid any, event int64, options ...RequestOptionFunc) (*AuditEvent, *Response, error)

func (*AuditEventsService) ListGroupAuditEvents added in v0.116.0 

func (s *AuditEventsService) ListGroupAuditEvents(gid any, opt *ListAuditEventsOptions, options ...RequestOptionFunc) ([]*AuditEvent, *Response, error)

func (*AuditEventsService) ListInstanceAuditEvents added in v0.116.0 

func (s *AuditEventsService) ListInstanceAuditEvents(opt *ListAuditEventsOptions, options ...RequestOptionFunc) ([]*AuditEvent, *Response, error)

func (*AuditEventsService) ListProjectAuditEvents added in v0.116.0 

func (s *AuditEventsService) ListProjectAuditEvents(pid any, opt *ListAuditEventsOptions, options ...RequestOptionFunc) ([]*AuditEvent, *Response, error)

type AuditEventsServiceInterface added in v0.126.0 

type AuditEventsServiceInterface interface {
	// ListInstanceAuditEvents gets a list of audit events for instance.
	// Authentication as Administrator is required.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/audit_events/#retrieve-all-instance-audit-events
	// ListInstanceAuditEvents gets a list of audit events for instance.
	// Authentication as Administrator is required.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/audit_events/#retrieve-all-instance-audit-events
	ListInstanceAuditEvents(opt *ListAuditEventsOptions, options ...RequestOptionFunc) ([]*AuditEvent, *Response, error)

	// GetInstanceAuditEvent gets a specific instance audit event.
	// Authentication as Administrator is required.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/audit_events/#retrieve-single-instance-audit-event
	GetInstanceAuditEvent(event int64, options ...RequestOptionFunc) (*AuditEvent, *Response, error)

	// ListGroupAuditEvents gets a list of audit events for the specified group
	// viewable by the authenticated user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/audit_events/#retrieve-all-group-audit-events
	ListGroupAuditEvents(gid any, opt *ListAuditEventsOptions, options ...RequestOptionFunc) ([]*AuditEvent, *Response, error)

	// GetGroupAuditEvent gets a specific group audit event.
	//
	// GitLab API docs: https://docs.gitlab.com/api/audit_events/#retrieve-a-specific-group-audit-event
	GetGroupAuditEvent(gid any, event int64, options ...RequestOptionFunc) (*AuditEvent, *Response, error)

	// ListProjectAuditEvents gets a list of audit events for the specified project
	// viewable by the authenticated user.
	//
	// GitLab API docs: https://docs.gitlab.com/api/audit_events/#retrieve-all-project-audit-events
	ListProjectAuditEvents(pid any, opt *ListAuditEventsOptions, options ...RequestOptionFunc) ([]*AuditEvent, *Response, error)

	// GetProjectAuditEvent gets a specific project audit event.
	//
	// GitLab API docs: https://docs.gitlab.com/api/audit_events/#retrieve-a-specific-project-audit-event
	GetProjectAuditEvent(pid any, event int64, options ...RequestOptionFunc) (*AuditEvent, *Response, error)
}

type AuthSource added in v0.130.0 

type AuthSource interface {
	// Init is called once before making any requests.
	// If the token source needs access to client to initialize itself, it should do so here.
	Init(context.Context, *Client) error

	// Header returns an authentication header. When no error is returned, the
	// key and value should never be empty.
	Header(ctx context.Context) (key, value string, err error)
}

AuthSource is used to obtain access tokens.

type AuthType added in v0.116.0 

type AuthType int

AuthType represents an authentication type within GitLab.

GitLab API docs: https://docs.gitlab.com/api/ 

const (
	BasicAuth AuthType = iota
	JobToken
	OAuthToken
	PrivateToken
)

List of available authentication types.

GitLab API docs: https://docs.gitlab.com/api/

type Author 

type Author struct {
	ID        int64      `json:"id"`
	Username  string     `json:"username"`
	Email     string     `json:"email"`
	Name      string     `json:"name"`
	State     string     `json:"state"`
	Blocked   bool       `json:"blocked"`
	CreatedAt *time.Time `json:"created_at"`
}

Author represents a GitLab commit author

type AvailabilityValue added in v0.116.0 

type AvailabilityValue string

AvailabilityValue represents an availability value within GitLab. 

const (
	NotSet AvailabilityValue = "not_set"
	Busy   AvailabilityValue = "busy"
)

List of available availability values.

Undocumented, see code at: https://gitlab.com/gitlab-org/gitlab-foss/-/blob/master/app/models/user_status.rb#L22

type Avatar added in v0.116.0 

type Avatar struct {
	AvatarURL string `json:"avatar_url"`
}

Avatar represents a GitLab avatar.

GitLab API docs: https://docs.gitlab.com/api/avatar/

type AvatarRequestsService added in v0.116.0 

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

AvatarRequestsService handles communication with the avatar related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/avatar/

func (*AvatarRequestsService) GetAvatar added in v0.116.0 

func (s *AvatarRequestsService) GetAvatar(opt *GetAvatarOptions, options ...RequestOptionFunc) (*Avatar, *Response, error)

type AvatarRequestsServiceInterface added in v0.126.0 

type AvatarRequestsServiceInterface interface {
	// GetAvatar gets the avatar URL for a user with the given email address.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/avatar/#get-details-on-an-account-avatar
	GetAvatar(opt *GetAvatarOptions, options ...RequestOptionFunc) (*Avatar, *Response, error)
}

type AwardEmoji added in v0.8.0 

type AwardEmoji struct {
	ID            int64      `json:"id"`
	Name          string     `json:"name"`
	User          BasicUser  `json:"user"`
	CreatedAt     *time.Time `json:"created_at"`
	UpdatedAt     *time.Time `json:"updated_at"`
	AwardableID   int64      `json:"awardable_id"`
	AwardableType string     `json:"awardable_type"`
}

AwardEmoji represents a GitLab Award Emoji.

GitLab API docs: https://docs.gitlab.com/api/emoji_reactions/

type AwardEmojiService added in v0.8.0 

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

AwardEmojiService handles communication with the emoji awards related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/emoji_reactions/

func (*AwardEmojiService) CreateIssueAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) CreateIssueAwardEmoji(pid any, issueIID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) CreateIssuesAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) CreateIssuesAwardEmojiOnNote(pid any, issueID, noteID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) CreateMergeRequestAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) CreateMergeRequestAwardEmoji(pid any, mergeRequestIID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) CreateMergeRequestAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) CreateMergeRequestAwardEmojiOnNote(pid any, mergeRequestIID, noteID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) CreateSnippetAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) CreateSnippetAwardEmoji(pid any, snippetID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) CreateSnippetAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) CreateSnippetAwardEmojiOnNote(pid any, snippetIID, noteID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) DeleteIssueAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) DeleteIssueAwardEmoji(pid any, issueIID, awardID int64, options ...RequestOptionFunc) (*Response, error)

func (*AwardEmojiService) DeleteIssuesAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) DeleteIssuesAwardEmojiOnNote(pid any, issueID, noteID, awardID int64, options ...RequestOptionFunc) (*Response, error)

func (*AwardEmojiService) DeleteMergeRequestAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) DeleteMergeRequestAwardEmoji(pid any, mergeRequestIID, awardID int64, options ...RequestOptionFunc) (*Response, error)

func (*AwardEmojiService) DeleteMergeRequestAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) DeleteMergeRequestAwardEmojiOnNote(pid any, mergeRequestIID, noteID, awardID int64, options ...RequestOptionFunc) (*Response, error)

func (*AwardEmojiService) DeleteSnippetAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) DeleteSnippetAwardEmoji(pid any, snippetID, awardID int64, options ...RequestOptionFunc) (*Response, error)

func (*AwardEmojiService) DeleteSnippetAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) DeleteSnippetAwardEmojiOnNote(pid any, snippetIID, noteID, awardID int64, options ...RequestOptionFunc) (*Response, error)

func (*AwardEmojiService) GetIssueAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) GetIssueAwardEmoji(pid any, issueIID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) GetIssuesAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) GetIssuesAwardEmojiOnNote(pid any, issueID, noteID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) GetMergeRequestAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) GetMergeRequestAwardEmoji(pid any, mergeRequestIID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) GetMergeRequestAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) GetMergeRequestAwardEmojiOnNote(pid any, mergeRequestIID, noteID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) GetSnippetAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) GetSnippetAwardEmoji(pid any, snippetID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) GetSnippetAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) GetSnippetAwardEmojiOnNote(pid any, snippetIID, noteID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

func (*AwardEmojiService) ListIssueAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) ListIssueAwardEmoji(pid any, issueIID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

func (*AwardEmojiService) ListIssuesAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) ListIssuesAwardEmojiOnNote(pid any, issueID, noteID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

func (*AwardEmojiService) ListMergeRequestAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) ListMergeRequestAwardEmoji(pid any, mergeRequestIID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

func (*AwardEmojiService) ListMergeRequestAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) ListMergeRequestAwardEmojiOnNote(pid any, mergeRequestIID, noteID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

func (*AwardEmojiService) ListSnippetAwardEmoji added in v0.8.0 

func (s *AwardEmojiService) ListSnippetAwardEmoji(pid any, snippetID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

func (*AwardEmojiService) ListSnippetAwardEmojiOnNote added in v0.8.0 

func (s *AwardEmojiService) ListSnippetAwardEmojiOnNote(pid any, snippetIID, noteID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

type AwardEmojiServiceInterface added in v0.126.0 

type AwardEmojiServiceInterface interface {
	// ListMergeRequestAwardEmoji gets a list of all award emoji on the merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#list-an-awardables-emoji-reactions
	ListMergeRequestAwardEmoji(pid any, mergeRequestIID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

	// ListIssueAwardEmoji gets a list of all award emoji on the issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#list-an-awardables-emoji-reactions
	ListIssueAwardEmoji(pid any, issueIID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

	// ListSnippetAwardEmoji gets a list of all award emoji on the snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#list-an-awardables-emoji-reactions
	ListSnippetAwardEmoji(pid any, snippetID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

	// GetMergeRequestAwardEmoji get an award emoji from merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#get-single-emoji-reaction
	GetMergeRequestAwardEmoji(pid any, mergeRequestIID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// GetIssueAwardEmoji get an award emoji from issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#get-single-emoji-reaction
	GetIssueAwardEmoji(pid any, issueIID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// GetSnippetAwardEmoji get an award emoji from snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#get-single-emoji-reaction
	GetSnippetAwardEmoji(pid any, snippetID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// CreateMergeRequestAwardEmoji get an award emoji from merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#add-a-new-emoji-reaction
	CreateMergeRequestAwardEmoji(pid any, mergeRequestIID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// CreateIssueAwardEmoji get an award emoji from issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#add-a-new-emoji-reaction
	CreateIssueAwardEmoji(pid any, issueIID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// CreateSnippetAwardEmoji get an award emoji from snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#add-a-new-emoji-reaction
	CreateSnippetAwardEmoji(pid any, snippetID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// DeleteIssueAwardEmoji delete award emoji on an issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#delete-an-emoji-reaction
	DeleteIssueAwardEmoji(pid any, issueIID, awardID int64, options ...RequestOptionFunc) (*Response, error)

	// DeleteMergeRequestAwardEmoji delete award emoji on a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#delete-an-emoji-reaction
	DeleteMergeRequestAwardEmoji(pid any, mergeRequestIID, awardID int64, options ...RequestOptionFunc) (*Response, error)

	// DeleteSnippetAwardEmoji delete award emoji on a snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#delete-an-emoji-reaction
	DeleteSnippetAwardEmoji(pid any, snippetID, awardID int64, options ...RequestOptionFunc) (*Response, error)

	// ListIssuesAwardEmojiOnNote gets a list of all award emoji on a note from the
	// issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#list-a-comments-emoji-reactions
	ListIssuesAwardEmojiOnNote(pid any, issueID, noteID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

	// ListMergeRequestAwardEmojiOnNote gets a list of all award emoji on a note
	// from the merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#list-a-comments-emoji-reactions
	ListMergeRequestAwardEmojiOnNote(pid any, mergeRequestIID, noteID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

	// ListSnippetAwardEmojiOnNote gets a list of all award emoji on a note from the
	// snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#list-a-comments-emoji-reactions
	ListSnippetAwardEmojiOnNote(pid any, snippetIID, noteID int64, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error)

	// GetIssuesAwardEmojiOnNote gets an award emoji on a note from an issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#get-an-emoji-reaction-for-a-comment
	GetIssuesAwardEmojiOnNote(pid any, issueID, noteID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// GetMergeRequestAwardEmojiOnNote gets an award emoji on a note from a
	// merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#get-an-emoji-reaction-for-a-comment
	GetMergeRequestAwardEmojiOnNote(pid any, mergeRequestIID, noteID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// GetSnippetAwardEmojiOnNote gets an award emoji on a note from a snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#get-an-emoji-reaction-for-a-comment
	GetSnippetAwardEmojiOnNote(pid any, snippetIID, noteID, awardID int64, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// CreateIssuesAwardEmojiOnNote gets an award emoji on a note from an issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#add-a-new-emoji-reaction-to-a-comment
	CreateIssuesAwardEmojiOnNote(pid any, issueID, noteID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// CreateMergeRequestAwardEmojiOnNote gets an award emoji on a note from a
	// merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#add-a-new-emoji-reaction-to-a-comment
	CreateMergeRequestAwardEmojiOnNote(pid any, mergeRequestIID, noteID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// CreateSnippetAwardEmojiOnNote gets an award emoji on a note from a snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#add-a-new-emoji-reaction-to-a-comment
	CreateSnippetAwardEmojiOnNote(pid any, snippetIID, noteID int64, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error)

	// DeleteIssuesAwardEmojiOnNote deletes an award emoji on a note from an issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#delete-an-emoji-reaction-from-a-comment
	DeleteIssuesAwardEmojiOnNote(pid any, issueID, noteID, awardID int64, options ...RequestOptionFunc) (*Response, error)

	// DeleteMergeRequestAwardEmojiOnNote deletes an award emoji on a note from a
	// merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#delete-an-emoji-reaction-from-a-comment
	DeleteMergeRequestAwardEmojiOnNote(pid any, mergeRequestIID, noteID, awardID int64, options ...RequestOptionFunc) (*Response, error)

	// DeleteSnippetAwardEmojiOnNote deletes an award emoji on a note from a snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/emoji_reactions/#delete-an-emoji-reaction-from-a-comment
	DeleteSnippetAwardEmojiOnNote(pid any, snippetIID, noteID, awardID int64, options ...RequestOptionFunc) (*Response, error)
}

type BadgeKind added in v0.116.0 

type BadgeKind string

BadgeKind represents a GitLab Badge Kind 

const (
	ProjectBadgeKind BadgeKind = "project"
	GroupBadgeKind   BadgeKind = "group"
)

all possible values Badge Kind

type BaseSystemEvent added in v0.116.0 

type BaseSystemEvent struct {
	EventName string `json:"event_name"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

BaseSystemEvent contains system hook's common properties.

GitLab API docs: https://docs.gitlab.com/administration/system_hooks/

type BasicMergeRequest added in v0.124.0 

type BasicMergeRequest struct {
	ID                          int64                  `json:"id"`
	IID                         int64                  `json:"iid"`
	TargetBranch                string                 `json:"target_branch"`
	SourceBranch                string                 `json:"source_branch"`
	ProjectID                   int64                  `json:"project_id"`
	Title                       string                 `json:"title"`
	State                       string                 `json:"state"`
	Imported                    bool                   `json:"imported"`
	ImportedFrom                string                 `json:"imported_from"`
	CreatedAt                   *time.Time             `json:"created_at"`
	UpdatedAt                   *time.Time             `json:"updated_at"`
	Upvotes                     int64                  `json:"upvotes"`
	Downvotes                   int64                  `json:"downvotes"`
	Author                      *BasicUser             `json:"author"`
	Assignee                    *BasicUser             `json:"assignee"`
	Assignees                   []*BasicUser           `json:"assignees"`
	Reviewers                   []*BasicUser           `json:"reviewers"`
	SourceProjectID             int64                  `json:"source_project_id"`
	TargetProjectID             int64                  `json:"target_project_id"`
	Labels                      Labels                 `json:"labels"`
	LabelDetails                []*LabelDetails        `json:"label_details"`
	Description                 string                 `json:"description"`
	Draft                       bool                   `json:"draft"`
	Milestone                   *Milestone             `json:"milestone"`
	MergeWhenPipelineSucceeds   bool                   `json:"merge_when_pipeline_succeeds"`
	DetailedMergeStatus         string                 `json:"detailed_merge_status"`
	MergeUser                   *BasicUser             `json:"merge_user"`
	MergedAt                    *time.Time             `json:"merged_at"`
	MergeAfter                  *time.Time             `json:"merge_after"`
	PreparedAt                  *time.Time             `json:"prepared_at"`
	ClosedBy                    *BasicUser             `json:"closed_by"`
	ClosedAt                    *time.Time             `json:"closed_at"`
	SHA                         string                 `json:"sha"`
	MergeCommitSHA              string                 `json:"merge_commit_sha"`
	SquashCommitSHA             string                 `json:"squash_commit_sha"`
	UserNotesCount              int64                  `json:"user_notes_count"`
	ShouldRemoveSourceBranch    bool                   `json:"should_remove_source_branch"`
	ForceRemoveSourceBranch     bool                   `json:"force_remove_source_branch"`
	AllowCollaboration          bool                   `json:"allow_collaboration"`
	AllowMaintainerToPush       bool                   `json:"allow_maintainer_to_push"`
	WebURL                      string                 `json:"web_url"`
	References                  *IssueReferences       `json:"references"`
	DiscussionLocked            bool                   `json:"discussion_locked"`
	TimeStats                   *TimeStats             `json:"time_stats"`
	Squash                      bool                   `json:"squash"`
	SquashOnMerge               bool                   `json:"squash_on_merge"`
	TaskCompletionStatus        *TasksCompletionStatus `json:"task_completion_status"`
	HasConflicts                bool                   `json:"has_conflicts"`
	BlockingDiscussionsResolved bool                   `json:"blocking_discussions_resolved"`

	// Deprecated: will be removed in v5 of the API, use MergeUser instead
	MergedBy *BasicUser `json:"merged_by"`
}

BasicMergeRequest represents a basic GitLab merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/

func (BasicMergeRequest) String added in v0.124.0 

func (m BasicMergeRequest) String() string

type BasicProject added in v0.116.0 

type BasicProject struct {
	ID                int64      `json:"id"`
	Description       string     `json:"description"`
	Name              string     `json:"name"`
	NameWithNamespace string     `json:"name_with_namespace"`
	Path              string     `json:"path"`
	PathWithNamespace string     `json:"path_with_namespace"`
	CreatedAt         *time.Time `json:"created_at"`
}

BasicProject included in other service responses (such as todos).

type BasicUser added in v0.116.0 

type BasicUser struct {
	ID       int64  `json:"id"`
	Username string `json:"username"`
	Name     string `json:"name"`

	// State represents the administrative status of the user account.
	// Common values: "active", "blocked", "deactivated", "banned",
	// "ldap_blocked", "blocked_pending_approval".
	//
	// This is independent from the Locked field: State tracks permanent
	// administrative actions, while Locked handles temporary login failures.
	State string `json:"state"`

	// Locked indicates whether the user account is temporarily locked due to
	// excessive failed login attempts. This is separate from administrative
	// blocking (the State field). Locks automatically expire after a configured
	// time period (default: 10 minutes).
	Locked bool `json:"locked"`

	CreatedAt *time.Time `json:"created_at"`
	AvatarURL string     `json:"avatar_url"`
	WebURL    string     `json:"web_url"`
}

BasicUser included in other service responses (such as merge requests, pipelines, etc).

type Batch added in v0.155.0 

type Batch struct {
	Status       int64     `json:"status"`
	BatchNumber  int64     `json:"batch_number"`
	ObjectsCount int64     `json:"objects_count"`
	Error        string    `json:"error"`
	UpdatedAt    time.Time `json:"updated_at"`
}

type BillableGroupMember added in v0.116.0 

type BillableGroupMember struct {
	ID             int64      `json:"id"`
	Username       string     `json:"username"`
	Name           string     `json:"name"`
	State          string     `json:"state"`
	AvatarURL      string     `json:"avatar_url"`
	WebURL         string     `json:"web_url"`
	Email          string     `json:"email"`
	LastActivityOn *ISOTime   `json:"last_activity_on"`
	MembershipType string     `json:"membership_type"`
	Removable      bool       `json:"removable"`
	CreatedAt      *time.Time `json:"created_at"`
	IsLastOwner    bool       `json:"is_last_owner"`
	LastLoginAt    *time.Time `json:"last_login_at"`
}

BillableGroupMember represents a GitLab billable group member.

GitLab API docs: https://docs.gitlab.com/api/members/#list-all-billable-members-of-a-group

type BillableUserMembership added in v0.116.0 

type BillableUserMembership struct {
	ID               int64               `json:"id"`
	SourceID         int64               `json:"source_id"`
	SourceFullName   string              `json:"source_full_name"`
	SourceMembersURL string              `json:"source_members_url"`
	CreatedAt        *time.Time          `json:"created_at"`
	ExpiresAt        *time.Time          `json:"expires_at"`
	AccessLevel      *AccessLevelDetails `json:"access_level"`
}

BillableUserMembership represents a Membership of a billable user of a group

GitLab API docs: https://docs.gitlab.com/api/members/#list-memberships-for-a-billable-member-of-a-group

type BitbucketCloudImport added in v0.116.0 

type BitbucketCloudImport struct {
	ID                    int64  `json:"id"`
	Name                  string `json:"name"`
	FullPath              string `json:"full_path"`
	FullName              string `json:"full_name"`
	RefsURL               string `json:"refs_url"`
	ImportSource          string `json:"import_source"`
	ImportStatus          string `json:"import_status"`
	HumanImportStatusName string `json:"human_import_status_name"`
	ProviderLink          string `json:"provider_link"`
	RelationType          string `json:"relation_type"`
	ImportWarning         string `json:"import_warning"`
}

BitbucketCloudImport represents the response from an import from Bitbucket Cloud.

GitLab API docs: https://docs.gitlab.com/api/import/#import-repository-from-bitbucket-cloud

func (BitbucketCloudImport) String added in v0.116.0 

func (s BitbucketCloudImport) String() string

type BitbucketServerImport added in v0.116.0 

type BitbucketServerImport struct {
	ID       int64  `json:"id"`
	Name     string `json:"name"`
	FullPath string `json:"full_path"`
	FullName string `json:"full_name"`
	RefsURL  string `json:"refs_url"`
}

BitbucketServerImport represents the response from an import from Bitbucket Server.

GitLab API docs: https://docs.gitlab.com/api/import/#import-repository-from-bitbucket-server

func (BitbucketServerImport) String added in v0.116.0 

func (s BitbucketServerImport) String() string

type Blob added in v0.9.0 

type Blob struct {
	Basename  string `json:"basename"`
	Data      string `json:"data"`
	Path      string `json:"path"`
	Filename  string `json:"filename"`
	ID        string `json:"id"`
	Ref       string `json:"ref"`
	Startline int64  `json:"startline"`
	ProjectID int64  `json:"project_id"`
}

Blob represents a single blob.

type BlockingMergeRequest added in v0.119.0 

type BlockingMergeRequest struct {
	ID                          int64                  `json:"id"`
	Iid                         int64                  `json:"iid"`
	TargetBranch                string                 `json:"target_branch"`
	SourceBranch                string                 `json:"source_branch"`
	ProjectID                   int64                  `json:"project_id"`
	Title                       string                 `json:"title"`
	State                       string                 `json:"state"`
	CreatedAt                   time.Time              `json:"created_at"`
	UpdatedAt                   time.Time              `json:"updated_at"`
	Upvotes                     int64                  `json:"upvotes"`
	Downvotes                   int64                  `json:"downvotes"`
	Author                      *BasicUser             `json:"author"`
	Assignee                    *BasicUser             `json:"assignee"`
	Assignees                   []*BasicUser           `json:"assignees"`
	Reviewers                   []*BasicUser           `json:"reviewers"`
	SourceProjectID             int64                  `json:"source_project_id"`
	TargetProjectID             int64                  `json:"target_project_id"`
	Labels                      *LabelOptions          `json:"labels"`
	Description                 string                 `json:"description"`
	Draft                       bool                   `json:"draft"`
	Milestone                   *string                `json:"milestone"`
	AutoMerge                   bool                   `json:"auto_merge"`
	DetailedMergeStatus         string                 `json:"detailed_merge_status"`
	MergedAt                    *time.Time             `json:"merged_at"`
	ClosedBy                    *BasicUser             `json:"closed_by"`
	ClosedAt                    *time.Time             `json:"closed_at"`
	Sha                         string                 `json:"sha"`
	MergeCommitSha              string                 `json:"merge_commit_sha"`
	SquashCommitSha             string                 `json:"squash_commit_sha"`
	UserNotesCount              int64                  `json:"user_notes_count"`
	ShouldRemoveSourceBranch    *bool                  `json:"should_remove_source_branch"`
	ForceRemoveSourceBranch     bool                   `json:"force_remove_source_branch"`
	WebURL                      string                 `json:"web_url"`
	References                  *IssueReferences       `json:"references"`
	DiscussionLocked            *bool                  `json:"discussion_locked"`
	TimeStats                   *TimeStats             `json:"time_stats"`
	Squash                      bool                   `json:"squash"`
	TaskCompletionStatus        *TasksCompletionStatus `json:"task_completion_status"`
	HasConflicts                bool                   `json:"has_conflicts"`
	BlockingDiscussionsResolved bool                   `json:"blocking_discussions_resolved"`
	MergeUser                   *BasicUser             `json:"merge_user"`
	MergeAfter                  time.Time              `json:"merge_after"`
	Imported                    bool                   `json:"imported"`
	ImportedFrom                string                 `json:"imported_from"`
	PreparedAt                  *time.Time             `json:"prepared_at"`
	SquashOnMerge               bool                   `json:"squash_on_merge"`

	// Deprecated: use Draft instead
	WorkInProgress bool `json:"work_in_progress"`
	// Deprecated: will be removed in v5 of the API, use AutoMerge instead
	MergeWhenPipelineSucceeds bool `json:"merge_when_pipeline_succeeds"`
	// Deprecated: will be removed in v5 of the API, use MergeUser instead
	MergedBy *BasicUser `json:"merged_by"`
	// Deprecated: will be removed in v5 of the API, use the Merge Request Approvals API instead
	ApprovalsBeforeMerge *int64 `json:"approvals_before_merge"`
	// Deprecated: will be removed in v5 of the API, use References instead
	Reference string `json:"reference"`
	// Deprecated: in 15.6, use DetailedMergeStatus instead
	MergeStatus string `json:"merge_status"`
}

BlockingMergeRequest represents a GitLab merge request dependency.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#create-a-merge-request-dependency

type BoardList added in v0.8.0 

type BoardList struct {
	ID             int64              `json:"id"`
	Assignee       *BoardListAssignee `json:"assignee"`
	Iteration      *ProjectIteration  `json:"iteration"`
	Label          *Label             `json:"label"`
	MaxIssueCount  int64              `json:"max_issue_count"`
	MaxIssueWeight int64              `json:"max_issue_weight"`
	Milestone      *Milestone         `json:"milestone"`
	Position       int64              `json:"position"`
}

BoardList represents a GitLab board list.

GitLab API docs: https://docs.gitlab.com/api/boards/

func (BoardList) String added in v0.8.0 

func (b BoardList) String() string

type BoardListAssignee added in v1.0.0 

type BoardListAssignee struct {
	ID       int64  `json:"id"`
	Name     string `json:"name"`
	Username string `json:"username"`
}

BoardListAssignee represents a GitLab board list assignee.

GitLab API docs: https://docs.gitlab.com/api/boards/

func (BoardListAssignee) String added in v1.0.0 

func (a BoardListAssignee) String() string

type BoolValue added in v0.11.0 

type BoolValue bool

BoolValue is a boolean value with advanced json unmarshaling features.

func (*BoolValue) UnmarshalJSON added in v0.11.0 

func (t *BoolValue) UnmarshalJSON(b []byte) error

UnmarshalJSON allows 1, 0, "true", and "false" to be considered as boolean values Needed for: https://gitlab.com/gitlab-org/gitlab-ce/issues/50122 https://gitlab.com/gitlab-org/gitlab/-/issues/233941 https://github.com/gitlabhq/terraform-provider-gitlab/issues/348

type Branch 

type Branch struct {
	Commit             *Commit `json:"commit"`
	Name               string  `json:"name"`
	Protected          bool    `json:"protected"`
	Merged             bool    `json:"merged"`
	Default            bool    `json:"default"`
	CanPush            bool    `json:"can_push"`
	DevelopersCanPush  bool    `json:"developers_can_push"`
	DevelopersCanMerge bool    `json:"developers_can_merge"`
	WebURL             string  `json:"web_url"`
}

Branch represents a GitLab branch.

GitLab API docs: https://docs.gitlab.com/api/branches/

func (Branch) String 

func (b Branch) String() string

type BranchAccessDescription added in v0.7.4 

type BranchAccessDescription struct {
	ID                     int64            `json:"id"`
	AccessLevel            AccessLevelValue `json:"access_level"`
	AccessLevelDescription string           `json:"access_level_description"`
	DeployKeyID            int64            `json:"deploy_key_id"`
	UserID                 int64            `json:"user_id"`
	GroupID                int64            `json:"group_id"`
}

BranchAccessDescription represents the access description for a protected branch.

GitLab API docs: https://docs.gitlab.com/api/protected_branches/#list-protected-branches

type BranchPermissionOptions added in v0.116.0 

type BranchPermissionOptions struct {
	ID          *int64            `url:"id,omitempty" json:"id,omitempty"`
	UserID      *int64            `url:"user_id,omitempty" json:"user_id,omitempty"`
	GroupID     *int64            `url:"group_id,omitempty" json:"group_id,omitempty"`
	DeployKeyID *int64            `url:"deploy_key_id,omitempty" json:"deploy_key_id,omitempty"`
	AccessLevel *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	Destroy     *bool             `url:"_destroy,omitempty" json:"_destroy,omitempty"`
}

BranchPermissionOptions represents a branch permission option.

GitLab API docs: https://docs.gitlab.com/api/protected_branches/#protect-repository-branches

type BranchProtectionDefaults added in v0.116.0 

type BranchProtectionDefaults struct {
	AllowedToPush             []*GroupAccessLevel `json:"allowed_to_push,omitempty"`
	AllowForcePush            bool                `json:"allow_force_push,omitempty"`
	AllowedToMerge            []*GroupAccessLevel `json:"allowed_to_merge,omitempty"`
	DeveloperCanInitialPush   bool                `json:"developer_can_initial_push,omitempty"`
	CodeOwnerApprovalRequired bool                `json:"code_owner_approval_required,omitempty"`
}

BranchProtectionDefaults represents default Git protected branch permissions.

GitLab API docs: https://docs.gitlab.com/api/groups/#options-for-default_branch_protection_defaults

type BranchProtectionDefaultsOptions added in v0.116.0 

type BranchProtectionDefaultsOptions struct {
	AllowedToPush           *[]int64 `url:"allowed_to_push,omitempty" json:"allowed_to_push,omitempty"`
	AllowForcePush          *bool    `url:"allow_force_push,omitempty" json:"allow_force_push,omitempty"`
	AllowedToMerge          *[]int64 `url:"allowed_to_merge,omitempty" json:"allowed_to_merge,omitempty"`
	DeveloperCanInitialPush *bool    `url:"developer_can_initial_push,omitempty" json:"developer_can_initial_push,omitempty"`
}

BranchProtectionDefaultsOptions represents default Git protected branch permissions options.

GitLab API docs: https://docs.gitlab.com/api/groups/#options-for-default_branch_protection_defaults

type BranchesService 

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

BranchesService handles communication with the branch related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/branches/

func (*BranchesService) CreateBranch 

func (s *BranchesService) CreateBranch(pid any, opt *CreateBranchOptions, options ...RequestOptionFunc) (*Branch, *Response, error)

func (*BranchesService) DeleteBranch 

func (s *BranchesService) DeleteBranch(pid any, branch string, options ...RequestOptionFunc) (*Response, error)

func (*BranchesService) DeleteMergedBranches added in v0.6.0 

func (s *BranchesService) DeleteMergedBranches(pid any, options ...RequestOptionFunc) (*Response, error)

func (*BranchesService) GetBranch 

func (s *BranchesService) GetBranch(pid any, branch string, options ...RequestOptionFunc) (*Branch, *Response, error)

func (*BranchesService) ListBranches 

func (s *BranchesService) ListBranches(pid any, opts *ListBranchesOptions, options ...RequestOptionFunc) ([]*Branch, *Response, error)

type BranchesServiceInterface added in v0.126.0 

type BranchesServiceInterface interface {
	// ListBranches gets a list of repository branches from a project, sorted by name alphabetically.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/branches/#list-repository-branches
	ListBranches(pid any, opts *ListBranchesOptions, options ...RequestOptionFunc) ([]*Branch, *Response, error)

	// GetBranch gets a single project repository branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/branches/#get-single-repository-branch
	GetBranch(pid any, branch string, options ...RequestOptionFunc) (*Branch, *Response, error)

	// CreateBranch creates branch from commit SHA or existing branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/branches/#create-repository-branch
	CreateBranch(pid any, opt *CreateBranchOptions, options ...RequestOptionFunc) (*Branch, *Response, error)

	// DeleteBranch deletes an existing branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/branches/#delete-repository-branch
	DeleteBranch(pid any, branch string, options ...RequestOptionFunc) (*Response, error)

	// DeleteMergedBranches deletes all branches that are merged into the project's default branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/branches/#delete-merged-branches
	DeleteMergedBranches(pid any, options ...RequestOptionFunc) (*Response, error)
}

type Bridge added in v0.116.0 

type Bridge struct {
	Commit             *Commit       `json:"commit"`
	Coverage           float64       `json:"coverage"`
	AllowFailure       bool          `json:"allow_failure"`
	CreatedAt          *time.Time    `json:"created_at"`
	StartedAt          *time.Time    `json:"started_at"`
	FinishedAt         *time.Time    `json:"finished_at"`
	ErasedAt           *time.Time    `json:"erased_at"`
	Duration           float64       `json:"duration"`
	QueuedDuration     float64       `json:"queued_duration"`
	ID                 int64         `json:"id"`
	Name               string        `json:"name"`
	Pipeline           PipelineInfo  `json:"pipeline"`
	Ref                string        `json:"ref"`
	Stage              string        `json:"stage"`
	Status             string        `json:"status"`
	FailureReason      string        `json:"failure_reason"`
	Tag                bool          `json:"tag"`
	WebURL             string        `json:"web_url"`
	User               *User         `json:"user"`
	DownstreamPipeline *PipelineInfo `json:"downstream_pipeline"`
}

Bridge represents a pipeline bridge.

GitLab API docs: https://docs.gitlab.com/api/jobs/#list-pipeline-trigger-jobs

type BroadcastMessage added in v0.8.1 

type BroadcastMessage struct {
	Message            string             `json:"message"`
	StartsAt           *time.Time         `json:"starts_at"`
	EndsAt             *time.Time         `json:"ends_at"`
	Font               string             `json:"font"`
	ID                 int64              `json:"id"`
	Active             bool               `json:"active"`
	TargetAccessLevels []AccessLevelValue `json:"target_access_levels"`
	TargetPath         string             `json:"target_path"`
	BroadcastType      string             `json:"broadcast_type"`
	Dismissable        bool               `json:"dismissable"`
	Theme              string             `json:"theme"`
}

BroadcastMessage represents a GitLab broadcast message.

GitLab API docs: https://docs.gitlab.com/api/broadcast_messages/#get-all-broadcast-messages

type BroadcastMessagesService added in v0.8.1 

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

BroadcastMessagesService handles communication with the broadcast messages methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/broadcast_messages/

func (*BroadcastMessagesService) CreateBroadcastMessage added in v0.8.1 

func (s *BroadcastMessagesService) CreateBroadcastMessage(opt *CreateBroadcastMessageOptions, options ...RequestOptionFunc) (*BroadcastMessage, *Response, error)

func (*BroadcastMessagesService) DeleteBroadcastMessage added in v0.8.1 

func (s *BroadcastMessagesService) DeleteBroadcastMessage(broadcast int64, options ...RequestOptionFunc) (*Response, error)

func (*BroadcastMessagesService) GetBroadcastMessage added in v0.8.1 

func (s *BroadcastMessagesService) GetBroadcastMessage(broadcast int64, options ...RequestOptionFunc) (*BroadcastMessage, *Response, error)

func (*BroadcastMessagesService) ListBroadcastMessages added in v0.8.1 

func (s *BroadcastMessagesService) ListBroadcastMessages(opt *ListBroadcastMessagesOptions, options ...RequestOptionFunc) ([]*BroadcastMessage, *Response, error)

func (*BroadcastMessagesService) UpdateBroadcastMessage added in v0.8.1 

func (s *BroadcastMessagesService) UpdateBroadcastMessage(broadcast int64, opt *UpdateBroadcastMessageOptions, options ...RequestOptionFunc) (*BroadcastMessage, *Response, error)

type BroadcastMessagesServiceInterface added in v0.126.0 

type BroadcastMessagesServiceInterface interface {
	// ListBroadcastMessages gets a list of all broadcasted messages.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/broadcast_messages/#get-all-broadcast-messages
	ListBroadcastMessages(opt *ListBroadcastMessagesOptions, options ...RequestOptionFunc) ([]*BroadcastMessage, *Response, error)

	// GetBroadcastMessage gets a single broadcast message.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/broadcast_messages/#get-a-specific-broadcast-message
	GetBroadcastMessage(broadcast int64, options ...RequestOptionFunc) (*BroadcastMessage, *Response, error)

	// CreateBroadcastMessage creates a message to broadcast.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/broadcast_messages/#create-a-broadcast-message
	CreateBroadcastMessage(opt *CreateBroadcastMessageOptions, options ...RequestOptionFunc) (*BroadcastMessage, *Response, error)

	// UpdateBroadcastMessage updates a broadcasted message.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/broadcast_messages/#update-a-broadcast-message
	UpdateBroadcastMessage(broadcast int64, opt *UpdateBroadcastMessageOptions, options ...RequestOptionFunc) (*BroadcastMessage, *Response, error)

	// DeleteBroadcastMessage deletes a broadcasted message.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/broadcast_messages/#delete-a-broadcast-message
	DeleteBroadcastMessage(broadcast int64, options ...RequestOptionFunc) (*Response, error)
}

type BuildEvent added in v0.4.0 

type BuildEvent struct {
	ObjectKind        string           `json:"object_kind"`
	Ref               string           `json:"ref"`
	Tag               bool             `json:"tag"`
	BeforeSHA         string           `json:"before_sha"`
	SHA               string           `json:"sha"`
	BuildID           int64            `json:"build_id"`
	BuildName         string           `json:"build_name"`
	BuildStage        string           `json:"build_stage"`
	BuildStatus       string           `json:"build_status"`
	BuildCreatedAt    string           `json:"build_created_at"`
	BuildStartedAt    string           `json:"build_started_at"`
	BuildFinishedAt   string           `json:"build_finished_at"`
	BuildDuration     float64          `json:"build_duration"`
	BuildAllowFailure bool             `json:"build_allow_failure"`
	ProjectID         int64            `json:"project_id"`
	ProjectName       string           `json:"project_name"`
	User              *EventUser       `json:"user"`
	Commit            BuildEventCommit `json:"commit"`
	Repository        *Repository      `json:"repository"`
}

BuildEvent represents a build event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#job-events

type BuildEventCommit added in v1.0.0 

type BuildEventCommit struct {
	ID          int64  `json:"id"`
	SHA         string `json:"sha"`
	Message     string `json:"message"`
	AuthorName  string `json:"author_name"`
	AuthorEmail string `json:"author_email"`
	Status      string `json:"status"`
	Duration    int64  `json:"duration"`
	StartedAt   string `json:"started_at"`
	FinishedAt  string `json:"finished_at"`
}

type BuildStateValue added in v0.8.0 

type BuildStateValue string

BuildStateValue represents a GitLab build state. 

const (
	Created            BuildStateValue = "created"
	WaitingForResource BuildStateValue = "waiting_for_resource"
	Preparing          BuildStateValue = "preparing"
	Pending            BuildStateValue = "pending"
	Running            BuildStateValue = "running"
	Success            BuildStateValue = "success"
	Failed             BuildStateValue = "failed"
	Canceled           BuildStateValue = "canceled"
	Skipped            BuildStateValue = "skipped"
	Manual             BuildStateValue = "manual"
	Scheduled          BuildStateValue = "scheduled"
)

These constants represent all valid build states.

type BulkImportStartMigrationConfiguration added in v0.123.0 

type BulkImportStartMigrationConfiguration struct {
	URL         *string `json:"url,omitempty"`
	AccessToken *string `json:"access_token,omitempty"`
}

BulkImportStartMigrationConfiguration represents the available configuration options to start a migration.

GitLab API docs: https://docs.gitlab.com/api/bulk_imports/#start-a-new-group-or-project-migration

type BulkImportStartMigrationEntity added in v0.123.0 

type BulkImportStartMigrationEntity struct {
	SourceType           *string `json:"source_type,omitempty"`
	SourceFullPath       *string `json:"source_full_path,omitempty"`
	DestinationSlug      *string `json:"destination_slug,omitempty"`
	DestinationNamespace *string `json:"destination_namespace,omitempty"`
	MigrateProjects      *bool   `json:"migrate_projects,omitempty"`
	MigrateMemberships   *bool   `json:"migrate_memberships,omitempty"`
}

BulkImportStartMigrationEntity represents the available entity options to start a migration.

GitLab API docs: https://docs.gitlab.com/api/bulk_imports/#start-a-new-group-or-project-migration

type BulkImportStartMigrationOptions added in v0.123.0 

type BulkImportStartMigrationOptions struct {
	Configuration *BulkImportStartMigrationConfiguration `json:"configuration,omitempty"`
	Entities      []BulkImportStartMigrationEntity       `json:"entities,omitempty"`
}

BulkImportStartMigrationOptions represents the available start migration options.

GitLab API docs: https://docs.gitlab.com/api/bulk_imports/#start-a-new-group-or-project-migration

type BulkImportStartMigrationResponse added in v0.123.0 

type BulkImportStartMigrationResponse struct {
	ID          int64     `json:"id"`
	Status      string    `json:"status"`
	SourceType  string    `json:"source_type"`
	SourceURL   string    `json:"source_url"`
	CreatedAt   time.Time `json:"created_at"`
	UpdatedAt   time.Time `json:"updated_at"`
	HasFailures bool      `json:"has_failures"`
}

BulkImportStartMigrationResponse represents the start migration response.

GitLab API docs: https://docs.gitlab.com/api/bulk_imports/#start-a-new-group-or-project-migration

type BulkImportsService added in v0.123.0 

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

BulkImportsService handles communication with GitLab's direct transfer API.

GitLab API docs: https://docs.gitlab.com/api/bulk_imports/

func (*BulkImportsService) StartMigration added in v0.123.0 

func (b *BulkImportsService) StartMigration(startMigrationOptions *BulkImportStartMigrationOptions, options ...RequestOptionFunc) (*BulkImportStartMigrationResponse, *Response, error)

type BulkImportsServiceInterface added in v0.126.0 

type BulkImportsServiceInterface interface {
	StartMigration(startMigrationOptions *BulkImportStartMigrationOptions, options ...RequestOptionFunc) (*BulkImportStartMigrationResponse, *Response, error)
}

type BurndownChartEvent added in v0.116.0 

type BurndownChartEvent struct {
	CreatedAt *time.Time `json:"created_at"`
	Weight    *int64     `json:"weight"`
	Action    *string    `json:"action"`
}

BurndownChartEvent represents a burnout chart event.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#get-all-burndown-chart-events-for-a-single-milestone

type CIPipelineVariablesMinimumOverrideRoleValue added in v0.116.0 

type CIPipelineVariablesMinimumOverrideRoleValue = string

CIPipelineVariablesMinimumOverrideRoleValue represents an access control value used for managing access to the CI Pipeline Variable Override feature.

GitLab API docs: https://docs.gitlab.com/api/projects/ 

const (
	CIPipelineVariablesNoOneAllowedRole CIPipelineVariablesMinimumOverrideRoleValue = "no_one_allowed"
	CiPipelineVariablesOwnerRole        CIPipelineVariablesMinimumOverrideRoleValue = "owner"
	CiPipelineVariablesMaintainerRole   CIPipelineVariablesMinimumOverrideRoleValue = "maintainer"
	CIPipelineVariablesDeveloperRole    CIPipelineVariablesMinimumOverrideRoleValue = "developer"
)

List of available CIPipelineVariablesMinimumOverrideRoleValue values.

GitLab API docs: https://docs.gitlab.com/api/projects/

type CIYMLTemplate added in v0.11.1 

type CIYMLTemplate struct {
	Name    string `json:"name"`
	Content string `json:"content"`
}

CIYMLTemplate represents a GitLab CI YML template.

GitLab API docs: https://docs.gitlab.com/api/templates/gitlab_ci_ymls/

type CIYMLTemplateListItem added in v0.116.0 

type CIYMLTemplateListItem struct {
	Key  string `json:"key"`
	Name string `json:"name"`
}

CIYMLTemplateListItem represents a GitLab CI YML template from the list.

GitLab API docs: https://docs.gitlab.com/api/templates/gitlab_ci_ymls/

type CIYMLTemplatesService added in v0.11.1 

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

CIYMLTemplatesService handles communication with the gitlab CI YML templates related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/templates/gitlab_ci_ymls/

func (*CIYMLTemplatesService) GetTemplate added in v0.11.1 

func (s *CIYMLTemplatesService) GetTemplate(key string, options ...RequestOptionFunc) (*CIYMLTemplate, *Response, error)

func (*CIYMLTemplatesService) ListAllTemplates added in v0.11.1 

func (s *CIYMLTemplatesService) ListAllTemplates(opt *ListCIYMLTemplatesOptions, options ...RequestOptionFunc) ([]*CIYMLTemplateListItem, *Response, error)

type CIYMLTemplatesServiceInterface added in v0.126.0 

type CIYMLTemplatesServiceInterface interface {
	// ListAllTemplates get all GitLab CI YML templates.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/templates/gitlab_ci_ymls/#list-gitlab-ci-yaml-templates
	ListAllTemplates(opt *ListCIYMLTemplatesOptions, options ...RequestOptionFunc) ([]*CIYMLTemplateListItem, *Response, error)

	// GetTemplate get a single GitLab CI YML template.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/templates/gitlab_ci_ymls/#single-gitlab-ci-yaml-template
	GetTemplate(key string, options ...RequestOptionFunc) (*CIYMLTemplate, *Response, error)
}

type CancelGitHubProjectImportOptions added in v0.116.0 

type CancelGitHubProjectImportOptions struct {
	ProjectID *int64 `url:"project_id,omitempty" json:"project_id,omitempty"`
}

CancelGitHubProjectImportOptions represents the available CancelGitHubProjectImport() options.

GitLab API docs: https://docs.gitlab.com/api/import/#cancel-github-project-import

type CancelledGitHubImport added in v0.116.0 

type CancelledGitHubImport struct {
	ID                    int64  `json:"id"`
	Name                  string `json:"name"`
	FullPath              string `json:"full_path"`
	FullName              string `json:"full_name"`
	ImportSource          string `json:"import_source"`
	ImportStatus          string `json:"import_status"`
	HumanImportStatusName string `json:"human_import_status_name"`
	ProviderLink          string `json:"provider_link"`
}

CancelledGitHubImport represents the response when canceling an import from GitHub.

GitLab API docs: https://docs.gitlab.com/api/import/#cancel-github-project-import

func (CancelledGitHubImport) String added in v0.116.0 

func (s CancelledGitHubImport) String() string

type ChangeAppearanceOptions added in v0.116.0 

type ChangeAppearanceOptions struct {
	Title                       *string `url:"title,omitempty" json:"title,omitempty"`
	Description                 *string `url:"description,omitempty" json:"description,omitempty"`
	PWAName                     *string `url:"pwa_name,omitempty" json:"pwa_name,omitempty"`
	PWAShortName                *string `url:"pwa_short_name,omitempty" json:"pwa_short_name,omitempty"`
	PWADescription              *string `url:"pwa_description,omitempty" json:"pwa_description,omitempty"`
	PWAIcon                     *string `url:"pwa_icon,omitempty" json:"pwa_icon,omitempty"`
	Favicon                     *string `url:"favicon,omitempty" json:"favicon,omitempty"`
	MemberGuidelines            *string `url:"member_guidelines,omitempty" json:"member_guidelines,omitempty"`
	NewProjectGuidelines        *string `url:"new_project_guidelines,omitempty" json:"new_project_guidelines,omitempty"`
	ProfileImageGuidelines      *string `url:"profile_image_guidelines,omitempty" json:"profile_image_guidelines,omitempty"`
	HeaderMessage               *string `url:"header_message,omitempty" json:"header_message,omitempty"`
	FooterMessage               *string `url:"footer_message,omitempty" json:"footer_message,omitempty"`
	MessageBackgroundColor      *string `url:"message_background_color,omitempty" json:"message_background_color,omitempty"`
	MessageFontColor            *string `url:"message_font_color,omitempty" json:"message_font_color,omitempty"`
	EmailHeaderAndFooterEnabled *bool   `url:"email_header_and_footer_enabled,omitempty" json:"email_header_and_footer_enabled,omitempty"`
	URL                         *string `url:"url,omitempty" json:"url,omitempty"`
}

ChangeAppearanceOptions represents the available ChangeAppearance() options.

GitLab API docs: https://docs.gitlab.com/api/appearance/#update-application-appearance

type ChangeApprovalConfigurationOptions added in v0.116.0 

type ChangeApprovalConfigurationOptions struct {
	DisableOverridingApproversPerMergeRequest *bool `` /* 126-byte string literal not displayed */
	MergeRequestsAuthorApproval               *bool `url:"merge_requests_author_approval,omitempty" json:"merge_requests_author_approval,omitempty"`
	MergeRequestsDisableCommittersApproval    *bool `url:"merge_requests_disable_committers_approval,omitempty" json:"merge_requests_disable_committers_approval,omitempty"`
	RequirePasswordToApprove                  *bool `url:"require_password_to_approve,omitempty" json:"require_password_to_approve,omitempty"`
	ResetApprovalsOnPush                      *bool `url:"reset_approvals_on_push,omitempty" json:"reset_approvals_on_push,omitempty"`
	SelectiveCodeOwnerRemovals                *bool `url:"selective_code_owner_removals,omitempty" json:"selective_code_owner_removals,omitempty"`

	// Deprecated: use Merge Request Approvals API instead
	ApprovalsBeforeMerge *int64 `url:"approvals_before_merge,omitempty" json:"approvals_before_merge,omitempty"`
}

ChangeApprovalConfigurationOptions represents the available ApprovalConfiguration() options.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#change-configuration

type ChangeMergeRequestApprovalConfigurationOptions deprecated added in v0.116.0 

type ChangeMergeRequestApprovalConfigurationOptions struct {
	ApprovalsRequired *int64 `url:"approvals_required,omitempty" json:"approvals_required,omitempty"`
}

ChangeMergeRequestApprovalConfigurationOptions represents the available ChangeMergeRequestApprovalConfiguration() options.

Deprecated: in GitLab 16.0

type ChangePlanLimitOptions added in v0.116.0 

type ChangePlanLimitOptions struct {
	PlanName                   *string `url:"plan_name,omitempty" json:"plan_name,omitempty"`
	ConanMaxFileSize           *int64  `url:"conan_max_file_size,omitempty" json:"conan_max_file_size,omitempty"`
	GenericPackagesMaxFileSize *int64  `url:"generic_packages_max_file_size,omitempty" json:"generic_packages_max_file_size,omitempty"`
	HelmMaxFileSize            *int64  `url:"helm_max_file_size,omitempty" json:"helm_max_file_size,omitempty"`
	MavenMaxFileSize           *int64  `url:"maven_max_file_size,omitempty" json:"maven_max_file_size,omitempty"`
	NPMMaxFileSize             *int64  `url:"npm_max_file_size,omitempty" json:"npm_max_file_size,omitempty"`
	NugetMaxFileSize           *int64  `url:"nuget_max_file_size,omitempty" json:"nuget_max_file_size,omitempty"`
	PyPiMaxFileSize            *int64  `url:"pypi_max_file_size,omitempty" json:"pypi_max_file_size,omitempty"`
	TerraformModuleMaxFileSize *int64  `url:"terraform_module_max_file_size,omitempty" json:"terraform_module_max_file_size,omitempty"`
}

ChangePlanLimitOptions represents the available ChangePlanLimits() options.

GitLab API docs: https://docs.gitlab.com/api/plan_limits/#change-plan-limits

type ChangelogData added in v0.116.0 

type ChangelogData struct {
	Notes string `json:"notes"`
}

ChangelogData represents the generated changelog data.

GitLab API docs: https://docs.gitlab.com/api/repositories/#generate-changelog-data

func (ChangelogData) String added in v0.116.0 

func (c ChangelogData) String() string

type CherryPickCommitOptions added in v0.4.1 

type CherryPickCommitOptions struct {
	Branch  *string `url:"branch,omitempty" json:"branch,omitempty"`
	DryRun  *bool   `url:"dry_run,omitempty" json:"dry_run,omitempty"`
	Message *string `url:"message,omitempty" json:"message,omitempty"`
}

CherryPickCommitOptions represents the available CherryPickCommit() options.

GitLab API docs: https://docs.gitlab.com/api/commits/#cherry-pick-a-commit

type ClearStatusAfterValue added in v0.129.0 

type ClearStatusAfterValue string

ClearStatusAfterValue represents the time period after which the user's status will be cleared.

The duration is specified using one of the constants defined in this package. 

const (
	ClearStatusAfter30Minutes ClearStatusAfterValue = "30_minutes"
	ClearStatusAfter3Hours    ClearStatusAfterValue = "3_hours"
	ClearStatusAfter8Hours    ClearStatusAfterValue = "8_hours"
	ClearStatusAfter1Day      ClearStatusAfterValue = "1_day"
	ClearStatusAfter3Days     ClearStatusAfterValue = "3_days"
	ClearStatusAfter7Days     ClearStatusAfterValue = "7_days"
	ClearStatusAfter30Days    ClearStatusAfterValue = "30_days"
)

List of available clear status after values.

https://docs.gitlab.com/api/users/#set-your-user-status:~:text=clear_status_after

type Client 

type Client struct {

	// User agent used when communicating with the GitLab API.
	UserAgent string

	// GraphQL interface
	GraphQL GraphQLInterface

	// Services used for talking to different parts of the GitLab API.
	AccessRequests                   AccessRequestsServiceInterface
	AdminCompliancePolicySettings    AdminCompliancePolicySettingsServiceInterface
	AlertManagement                  AlertManagementServiceInterface
	Appearance                       AppearanceServiceInterface
	Applications                     ApplicationsServiceInterface
	ApplicationStatistics            ApplicationStatisticsServiceInterface
	Attestations                     AttestationsServiceInterface
	AuditEvents                      AuditEventsServiceInterface
	Avatar                           AvatarRequestsServiceInterface
	AwardEmoji                       AwardEmojiServiceInterface
	Boards                           IssueBoardsServiceInterface
	Branches                         BranchesServiceInterface
	BroadcastMessage                 BroadcastMessagesServiceInterface
	BulkImports                      BulkImportsServiceInterface
	CIYMLTemplate                    CIYMLTemplatesServiceInterface
	ClusterAgents                    ClusterAgentsServiceInterface
	Commits                          CommitsServiceInterface
	ContainerRegistry                ContainerRegistryServiceInterface
	ContainerRegistryProtectionRules ContainerRegistryProtectionRulesServiceInterface
	CustomAttribute                  CustomAttributesServiceInterface
	DatabaseMigrations               DatabaseMigrationsServiceInterface
	Dependencies                     DependenciesServiceInterface
	DependencyListExport             DependencyListExportServiceInterface
	DependencyProxy                  DependencyProxyServiceInterface
	DeployKeys                       DeployKeysServiceInterface
	DeployTokens                     DeployTokensServiceInterface
	DeploymentMergeRequests          DeploymentMergeRequestsServiceInterface
	Deployments                      DeploymentsServiceInterface
	Discussions                      DiscussionsServiceInterface
	DockerfileTemplate               DockerfileTemplatesServiceInterface
	DORAMetrics                      DORAMetricsServiceInterface
	DraftNotes                       DraftNotesServiceInterface
	EnterpriseUsers                  EnterpriseUsersServiceInterface
	Environments                     EnvironmentsServiceInterface
	EpicIssues                       EpicIssuesServiceInterface
	Epics                            EpicsServiceInterface
	ErrorTracking                    ErrorTrackingServiceInterface
	Events                           EventsServiceInterface
	ExternalStatusChecks             ExternalStatusChecksServiceInterface
	FeatureFlagUserLists             FeatureFlagUserListsServiceInterface
	Features                         FeaturesServiceInterface
	FreezePeriods                    FreezePeriodsServiceInterface
	GenericPackages                  GenericPackagesServiceInterface
	GeoNodes                         GeoNodesServiceInterface
	GeoSites                         GeoSitesServiceInterface
	GitIgnoreTemplates               GitIgnoreTemplatesServiceInterface
	GroupAccessTokens                GroupAccessTokensServiceInterface
	GroupActivityAnalytics           GroupActivityAnalyticsServiceInterface
	GroupBadges                      GroupBadgesServiceInterface
	GroupCluster                     GroupClustersServiceInterface
	GroupCredentials                 GroupCredentialsServiceInterface
	GroupEpicBoards                  GroupEpicBoardsServiceInterface
	GroupImportExport                GroupImportExportServiceInterface
	Integrations                     IntegrationsServiceInterface
	GroupIssueBoards                 GroupIssueBoardsServiceInterface
	GroupIterations                  GroupIterationsServiceInterface
	GroupLabels                      GroupLabelsServiceInterface
	GroupMarkdownUploads             GroupMarkdownUploadsServiceInterface
	GroupMembers                     GroupMembersServiceInterface
	GroupMilestones                  GroupMilestonesServiceInterface
	GroupProtectedEnvironments       GroupProtectedEnvironmentsServiceInterface
	GroupProtectedBranches           GroupProtectedBranchesServiceInterface
	GroupRelationsExport             GroupRelationsExportServiceInterface
	GroupReleases                    GroupReleasesServiceInterface
	GroupRepositoryStorageMove       GroupRepositoryStorageMoveServiceInterface
	GroupSCIM                        GroupSCIMServiceInterface
	GroupSecuritySettings            GroupSecuritySettingsServiceInterface
	GroupSSHCertificates             GroupSSHCertificatesServiceInterface
	GroupVariables                   GroupVariablesServiceInterface
	GroupWikis                       GroupWikisServiceInterface
	Groups                           GroupsServiceInterface
	Import                           ImportServiceInterface
	InstanceCluster                  InstanceClustersServiceInterface
	InstanceVariables                InstanceVariablesServiceInterface
	Invites                          InvitesServiceInterface
	IssueLinks                       IssueLinksServiceInterface
	Issues                           IssuesServiceInterface
	IssuesStatistics                 IssuesStatisticsServiceInterface
	Jobs                             JobsServiceInterface
	JobTokenScope                    JobTokenScopeServiceInterface
	Keys                             KeysServiceInterface
	Labels                           LabelsServiceInterface
	License                          LicenseServiceInterface
	LicenseTemplates                 LicenseTemplatesServiceInterface
	Markdown                         MarkdownServiceInterface
	MemberRolesService               MemberRolesServiceInterface
	MergeRequestApprovals            MergeRequestApprovalsServiceInterface
	MergeRequestApprovalSettings     MergeRequestApprovalSettingsServiceInterface
	MergeRequestContextCommits       MergeRequestContextCommitsServiceInterface
	MergeRequests                    MergeRequestsServiceInterface
	MergeTrains                      MergeTrainsServiceInterface
	Metadata                         MetadataServiceInterface
	Milestones                       MilestonesServiceInterface
	ModelRegistry                    ModelRegistryServiceInterface
	Namespaces                       NamespacesServiceInterface
	Notes                            NotesServiceInterface
	NotificationSettings             NotificationSettingsServiceInterface
	Packages                         PackagesServiceInterface
	Pages                            PagesServiceInterface
	PagesDomains                     PagesDomainsServiceInterface
	PersonalAccessTokens             PersonalAccessTokensServiceInterface
	PipelineSchedules                PipelineSchedulesServiceInterface
	PipelineTriggers                 PipelineTriggersServiceInterface
	Pipelines                        PipelinesServiceInterface
	PlanLimits                       PlanLimitsServiceInterface
	ProjectAccessTokens              ProjectAccessTokensServiceInterface
	ProjectAliases                   ProjectAliasesServiceInterface
	ProjectBadges                    ProjectBadgesServiceInterface
	ProjectCluster                   ProjectClustersServiceInterface
	ProjectFeatureFlags              ProjectFeatureFlagServiceInterface
	ProjectImportExport              ProjectImportExportServiceInterface
	ProjectIterations                ProjectIterationsServiceInterface
	ProjectMarkdownUploads           ProjectMarkdownUploadsServiceInterface
	ProjectMembers                   ProjectMembersServiceInterface
	ProjectMirrors                   ProjectMirrorServiceInterface
	ProjectRepositoryStorageMove     ProjectRepositoryStorageMoveServiceInterface
	ProjectSecuritySettings          ProjectSecuritySettingsServiceInterface
	ProjectSnippets                  ProjectSnippetsServiceInterface
	ProjectStatistics                ProjectStatisticsServiceInterface
	ProjectTemplates                 ProjectTemplatesServiceInterface
	ProjectVariables                 ProjectVariablesServiceInterface
	ProjectVulnerabilities           ProjectVulnerabilitiesServiceInterface
	Projects                         ProjectsServiceInterface
	ProtectedBranches                ProtectedBranchesServiceInterface
	ProtectedEnvironments            ProtectedEnvironmentsServiceInterface
	ProtectedPackages                ProtectedPackagesServiceInterface
	ProtectedTags                    ProtectedTagsServiceInterface
	ReleaseLinks                     ReleaseLinksServiceInterface
	Releases                         ReleasesServiceInterface
	Repositories                     RepositoriesServiceInterface
	RepositoryFiles                  RepositoryFilesServiceInterface
	RepositorySubmodules             RepositorySubmodulesServiceInterface
	ResourceGroup                    ResourceGroupServiceInterface
	ResourceIterationEvents          ResourceIterationEventsServiceInterface
	ResourceLabelEvents              ResourceLabelEventsServiceInterface
	ResourceMilestoneEvents          ResourceMilestoneEventsServiceInterface
	ResourceStateEvents              ResourceStateEventsServiceInterface
	ResourceWeightEvents             ResourceWeightEventsServiceInterface
	RunnerControllers                RunnerControllersServiceInterface
	RunnerControllerScopes           RunnerControllerScopesServiceInterface
	RunnerControllerTokens           RunnerControllerTokensServiceInterface
	Runners                          RunnersServiceInterface
	Search                           SearchServiceInterface
	SecureFiles                      SecureFilesServiceInterface
	Services                         ServicesServiceInterface
	Settings                         SettingsServiceInterface
	Sidekiq                          SidekiqServiceInterface
	SnippetRepositoryStorageMove     SnippetRepositoryStorageMoveServiceInterface
	Snippets                         SnippetsServiceInterface
	SystemHooks                      SystemHooksServiceInterface
	Tags                             TagsServiceInterface
	TerraformStates                  TerraformStatesServiceInterface
	Todos                            TodosServiceInterface
	Topics                           TopicsServiceInterface
	UsageData                        UsageDataServiceInterface
	Users                            UsersServiceInterface
	Validate                         ValidateServiceInterface
	Version                          VersionServiceInterface
	Wikis                            WikisServiceInterface
	WorkItems                        WorkItemsServiceInterface
	// contains filtered or unexported fields
}

A Client manages communication with the GitLab API.

func NewAuthSourceClient added in v0.130.0 

func NewAuthSourceClient(as AuthSource, options ...ClientOptionFunc) (*Client, error)

NewAuthSourceClient returns a new GitLab API client that uses the AuthSource for authentication.

func NewBasicAuthClient deprecated added in v0.10.1 

func NewBasicAuthClient(username, password string, options ...ClientOptionFunc) (*Client, error)

NewBasicAuthClient returns a new GitLab API client using the OAuth 2.0 Resource Owner Password Credentials flow. The provided username and password are used to obtain an OAuth access token from GitLab's token endpoint on the first API request. The token is then cached, reused for subsequent requests, and refreshed when expired.

The Resource Owner Password Credentials flow is only suitable for trusted, first-party applications and does not work for users who have two-factor authentication enabled.

Note: This method uses OAuth tokens with Bearer authentication, not HTTP Basic Auth.

Deprecated: GitLab recommends against using this authentication method.

func NewClient 

func NewClient(token string, options ...ClientOptionFunc) (*Client, error)

NewClient returns a new GitLab API client. To use API methods which require authentication, provide a valid private or personal token.

func NewJobClient added in v0.116.0 

func NewJobClient(token string, options ...ClientOptionFunc) (*Client, error)

NewJobClient returns a new GitLab API client. To use API methods which require authentication, provide a valid job token.

func NewOAuthClient deprecated 

func NewOAuthClient(token string, options ...ClientOptionFunc) (*Client, error)

NewOAuthClient returns a new GitLab API client using a static OAuth bearer token for authentication.

Deprecated: use NewAuthSourceClient with a StaticTokenSource instead. For example: 

ts := oauth2.StaticTokenSource(
    &oauth2.Token{AccessToken: "YOUR STATIC TOKEN"},
)
c, err := gitlab.NewAuthSourceClient(gitlab.OAuthTokenSource{ts})

func (*Client) BaseURL 

func (c *Client) BaseURL() *url.URL

BaseURL return a copy of the baseURL.

func (*Client) Do 

func (c *Client) Do(req *retryablehttp.Request, v any) (*Response, error)

Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occurred. If v implements the io.Writer interface, the raw response body will be written to v, without attempting to first decode it.

func (*Client) HTTPClient added in v0.136.0 

func (c *Client) HTTPClient() *http.Client

func (*Client) NewRequest 

func (c *Client) NewRequest(method, path string, opt any, options []RequestOptionFunc) (*retryablehttp.Request, error)

NewRequest creates a new API request. The method expects a relative URL path that will be resolved relative to the base URL of the Client. Relative URL paths should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included as the request body.

func (*Client) NewRequestToURL added in v0.136.0 

func (c *Client) NewRequestToURL(method string, u *url.URL, opt any, options []RequestOptionFunc) (*retryablehttp.Request, error)

func (*Client) UploadRequest added in v0.116.0 

func (c *Client) UploadRequest(method, path string, content io.Reader, filename string, uploadType UploadType, opt any, options []RequestOptionFunc) (*retryablehttp.Request, error)

UploadRequest creates an API request for uploading a file. The method expects a relative URL path that will be resolved relative to the base URL of the Client. Relative URL paths should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included as the request body.

type ClientOptionFunc added in v0.116.0 

type ClientOptionFunc func(*Client) error

ClientOptionFunc can be used to customize a new GitLab API client.

func WithBaseURL added in v0.116.0 

func WithBaseURL(urlStr string) ClientOptionFunc

WithBaseURL sets the base URL for API requests to a custom endpoint.

func WithCookieJar added in v0.140.0 

func WithCookieJar(jar http.CookieJar) ClientOptionFunc

WithCookieJar can be used to configure a cookie jar.

func WithCustomBackoff added in v0.116.0 

func WithCustomBackoff(backoff retryablehttp.Backoff) ClientOptionFunc

WithCustomBackoff can be used to configure a custom backoff policy.

func WithCustomLeveledLogger added in v0.116.0 

func WithCustomLeveledLogger(leveledLogger retryablehttp.LeveledLogger) ClientOptionFunc

WithCustomLeveledLogger can be used to configure a custom retryablehttp leveled logger.

func WithCustomLimiter added in v0.116.0 

func WithCustomLimiter(limiter RateLimiter) ClientOptionFunc

WithCustomLimiter injects a custom rate limiter to the client.

func WithCustomLogger added in v0.116.0 

func WithCustomLogger(logger retryablehttp.Logger) ClientOptionFunc

WithCustomLogger can be used to configure a custom retryablehttp logger.

func WithCustomRetry added in v0.116.0 

func WithCustomRetry(checkRetry retryablehttp.CheckRetry) ClientOptionFunc

WithCustomRetry can be used to configure a custom retry policy.

func WithCustomRetryMax added in v0.116.0 

func WithCustomRetryMax(retryMax int) ClientOptionFunc

WithCustomRetryMax can be used to configure a custom maximum number of retries.

func WithCustomRetryWaitMinMax added in v0.116.0 

func WithCustomRetryWaitMinMax(waitMin, waitMax time.Duration) ClientOptionFunc

WithCustomRetryWaitMinMax can be used to configure a custom minimum and maximum time to wait between retries.

func WithErrorHandler added in v0.116.0 

func WithErrorHandler(handler retryablehttp.ErrorHandler) ClientOptionFunc

WithErrorHandler can be used to configure a custom error handler.

func WithHTTPClient added in v0.116.0 

func WithHTTPClient(httpClient *http.Client) ClientOptionFunc

WithHTTPClient can be used to configure a custom HTTP client.

func WithInterceptor added in v0.144.0 

func WithInterceptor(i Interceptor) ClientOptionFunc

WithInterceptor registers an Interceptor in the client's http request call pipeline. It returns a ClientOptionFunc that adds the interceptor to the client.

func WithRequestLogHook added in v0.116.0 

func WithRequestLogHook(hook retryablehttp.RequestLogHook) ClientOptionFunc

WithRequestLogHook can be used to configure a custom request log hook.

func WithRequestOptions added in v0.116.0 

func WithRequestOptions(options ...RequestOptionFunc) ClientOptionFunc

WithRequestOptions can be used to configure default request options applied to every request.

func WithResponseLogHook added in v0.116.0 

func WithResponseLogHook(hook retryablehttp.ResponseLogHook) ClientOptionFunc

WithResponseLogHook can be used to configure a custom response log hook.

func WithURLWarningLogger added in v1.21.0 

func WithURLWarningLogger(logger *slog.Logger) ClientOptionFunc

WithURLWarningLogger sets a custom logger for URL validation warnings. By default, warnings are logged using slog.Default(). Pass slog.New(slog.DiscardHandler) to disable warnings.

func WithUserAgent added in v0.132.0 

func WithUserAgent(userAgent string) ClientOptionFunc

WithUserAgent can be used to configure a custom user agent.

func WithoutRetries added in v0.116.0 

func WithoutRetries() ClientOptionFunc

WithoutRetries disables the default retry logic.

type ClusterAgentsService added in v0.116.0 

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

ClusterAgentsService handles communication with the cluster agents related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/cluster_agents/

func (*ClusterAgentsService) CreateAgentToken added in v0.116.0 

func (s *ClusterAgentsService) CreateAgentToken(pid any, aid int64, opt *CreateAgentTokenOptions, options ...RequestOptionFunc) (*AgentToken, *Response, error)

func (*ClusterAgentsService) DeleteAgent added in v0.116.0 

func (s *ClusterAgentsService) DeleteAgent(pid any, id int64, options ...RequestOptionFunc) (*Response, error)

func (*ClusterAgentsService) GetAgent added in v0.116.0 

func (s *ClusterAgentsService) GetAgent(pid any, id int64, options ...RequestOptionFunc) (*Agent, *Response, error)

func (*ClusterAgentsService) GetAgentToken added in v0.116.0 

func (s *ClusterAgentsService) GetAgentToken(pid any, aid int64, id int64, options ...RequestOptionFunc) (*AgentToken, *Response, error)

func (*ClusterAgentsService) ListAgentTokens added in v0.116.0 

func (s *ClusterAgentsService) ListAgentTokens(pid any, aid int64, opt *ListAgentTokensOptions, options ...RequestOptionFunc) ([]*AgentToken, *Response, error)

func (*ClusterAgentsService) ListAgents added in v0.116.0 

func (s *ClusterAgentsService) ListAgents(pid any, opt *ListAgentsOptions, options ...RequestOptionFunc) ([]*Agent, *Response, error)

func (*ClusterAgentsService) RegisterAgent added in v0.116.0 

func (s *ClusterAgentsService) RegisterAgent(pid any, opt *RegisterAgentOptions, options ...RequestOptionFunc) (*Agent, *Response, error)

func (*ClusterAgentsService) RevokeAgentToken added in v0.116.0 

func (s *ClusterAgentsService) RevokeAgentToken(pid any, aid int64, id int64, options ...RequestOptionFunc) (*Response, error)

type ClusterAgentsServiceInterface added in v0.126.0 

type ClusterAgentsServiceInterface interface {
	// ListAgents returns a list of agents registered for the project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/cluster_agents/#list-the-agents-for-a-project
	// ListAgents returns a list of agents registered for the project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/cluster_agents/#list-the-agents-for-a-project
	ListAgents(pid any, opt *ListAgentsOptions, options ...RequestOptionFunc) ([]*Agent, *Response, error)

	// GetAgent gets a single agent details.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/cluster_agents/#get-details-about-an-agent
	GetAgent(pid any, id int64, options ...RequestOptionFunc) (*Agent, *Response, error)

	// RegisterAgent registers an agent to the project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/cluster_agents/#register-an-agent-with-a-project
	RegisterAgent(pid any, opt *RegisterAgentOptions, options ...RequestOptionFunc) (*Agent, *Response, error)

	// DeleteAgent deletes an existing agent registration.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/cluster_agents/#delete-a-registered-agent
	DeleteAgent(pid any, id int64, options ...RequestOptionFunc) (*Response, error)

	// ListAgentTokens returns a list of tokens for an agent.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/cluster_agents/#list-tokens-for-an-agent
	ListAgentTokens(pid any, aid int64, opt *ListAgentTokensOptions, options ...RequestOptionFunc) ([]*AgentToken, *Response, error)

	// GetAgentToken gets a single agent token.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/cluster_agents/#get-a-single-agent-token
	GetAgentToken(pid any, aid int64, id int64, options ...RequestOptionFunc) (*AgentToken, *Response, error)

	// CreateAgentToken creates a new token for an agent.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/cluster_agents/#create-an-agent-token
	CreateAgentToken(pid any, aid int64, opt *CreateAgentTokenOptions, options ...RequestOptionFunc) (*AgentToken, *Response, error)

	// RevokeAgentToken revokes an agent token.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/cluster_agents/#revoke-an-agent-token
	RevokeAgentToken(pid any, aid int64, id int64, options ...RequestOptionFunc) (*Response, error)
}

type CommentEventAction added in v0.116.0 

type CommentEventAction string

CommentEventAction identifies if a comment has been newly created or updated.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#comment-events 

const (
	CommentEventActionCreate CommentEventAction = "create"
	CommentEventActionUpdate CommentEventAction = "update"
)

type Commit 

type Commit struct {
	ID               string            `json:"id"`
	ShortID          string            `json:"short_id"`
	Title            string            `json:"title"`
	AuthorName       string            `json:"author_name"`
	AuthorEmail      string            `json:"author_email"`
	AuthoredDate     *time.Time        `json:"authored_date"`
	CommitterName    string            `json:"committer_name"`
	CommitterEmail   string            `json:"committer_email"`
	CommittedDate    *time.Time        `json:"committed_date"`
	CreatedAt        *time.Time        `json:"created_at"`
	Message          string            `json:"message"`
	ParentIDs        []string          `json:"parent_ids"`
	Stats            *CommitStats      `json:"stats"`
	Status           *BuildStateValue  `json:"status"`
	LastPipeline     *PipelineInfo     `json:"last_pipeline"`
	ProjectID        int64             `json:"project_id"`
	Trailers         map[string]string `json:"trailers"`
	ExtendedTrailers map[string]string `json:"extended_trailers"`
	WebURL           string            `json:"web_url"`
}

Commit represents a GitLab commit.

GitLab API docs: https://docs.gitlab.com/api/commits/

func (Commit) String 

func (c Commit) String() string

type CommitActionOptions added in v0.116.0 

type CommitActionOptions struct {
	Action          *FileActionValue `url:"action,omitempty" json:"action,omitempty"`
	FilePath        *string          `url:"file_path,omitempty" json:"file_path,omitempty"`
	PreviousPath    *string          `url:"previous_path,omitempty" json:"previous_path,omitempty"`
	Content         *string          `url:"content,omitempty" json:"content,omitempty"`
	Encoding        *string          `url:"encoding,omitempty" json:"encoding,omitempty"`
	LastCommitID    *string          `url:"last_commit_id,omitempty" json:"last_commit_id,omitempty"`
	ExecuteFilemode *bool            `url:"execute_filemode,omitempty" json:"execute_filemode,omitempty"`
}

CommitActionOptions represents the available options for a new single file action.

GitLab API docs: https://docs.gitlab.com/api/commits/#create-a-commit-with-multiple-files-and-actions

type CommitComment 

type CommitComment struct {
	Note     string `json:"note"`
	Path     string `json:"path"`
	Line     int64  `json:"line"`
	LineType string `json:"line_type"`
	Author   Author `json:"author"`
}

CommitComment represents a GitLab commit comment.

GitLab API docs: https://docs.gitlab.com/api/commits/

func (CommitComment) String 

func (c CommitComment) String() string

type CommitCommentEvent added in v0.3.1 

type CommitCommentEvent struct {
	ObjectKind       string                             `json:"object_kind"`
	EventType        string                             `json:"event_type"`
	User             *User                              `json:"user"`
	ProjectID        int64                              `json:"project_id"`
	Project          CommitCommentEventProject          `json:"project"`
	Repository       *Repository                        `json:"repository"`
	ObjectAttributes CommitCommentEventObjectAttributes `json:"object_attributes"`
	Commit           *CommitCommentEventCommit          `json:"commit"`
}

CommitCommentEvent represents a comment on a commit event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#comment-on-a-commit

type CommitCommentEventCommit added in v1.0.0 

type CommitCommentEventCommit struct {
	ID        string            `json:"id"`
	Title     string            `json:"title"`
	Message   string            `json:"message"`
	Timestamp *time.Time        `json:"timestamp"`
	URL       string            `json:"url"`
	Author    EventCommitAuthor `json:"author"`
}

type CommitCommentEventObjectAttributes added in v1.0.0 

type CommitCommentEventObjectAttributes struct {
	ID           int64              `json:"id"`
	Note         string             `json:"note"`
	NoteableType string             `json:"noteable_type"`
	AuthorID     int64              `json:"author_id"`
	CreatedAt    string             `json:"created_at"`
	UpdatedAt    string             `json:"updated_at"`
	ProjectID    int64              `json:"project_id"`
	Attachment   string             `json:"attachment"`
	LineCode     string             `json:"line_code"`
	CommitID     string             `json:"commit_id"`
	NoteableID   int64              `json:"noteable_id"`
	System       bool               `json:"system"`
	StDiff       *Diff              `json:"st_diff"`
	Description  string             `json:"description"`
	Action       CommentEventAction `json:"action"`
	URL          string             `json:"url"`
}

type CommitCommentEventProject added in v1.0.0 

type CommitCommentEventProject struct {
	ID                int64           `json:"id"`
	Name              string          `json:"name"`
	Description       string          `json:"description"`
	AvatarURL         string          `json:"avatar_url"`
	GitSSHURL         string          `json:"git_ssh_url"`
	GitHTTPURL        string          `json:"git_http_url"`
	Namespace         string          `json:"namespace"`
	PathWithNamespace string          `json:"path_with_namespace"`
	DefaultBranch     string          `json:"default_branch"`
	Homepage          string          `json:"homepage"`
	URL               string          `json:"url"`
	SSHURL            string          `json:"ssh_url"`
	HTTPURL           string          `json:"http_url"`
	WebURL            string          `json:"web_url"`
	Visibility        VisibilityValue `json:"visibility"`
}

type CommitRef added in v0.10.8 

type CommitRef struct {
	Type string `json:"type"`
	Name string `json:"name"`
}

CommitRef represents the reference of branches/tags in a commit.

GitLab API docs: https://docs.gitlab.com/api/commits/#get-references-a-commit-is-pushed-to

type CommitStats added in v0.4.1 

type CommitStats struct {
	Additions int64 `json:"additions"`
	Deletions int64 `json:"deletions"`
	Total     int64 `json:"total"`
}

CommitStats represents the number of added and deleted files in a commit.

GitLab API docs: https://docs.gitlab.com/api/commits/

type CommitStatus 

type CommitStatus struct {
	ID           int64      `json:"id"`
	SHA          string     `json:"sha"`
	Ref          string     `json:"ref"`
	Status       string     `json:"status"`
	CreatedAt    *time.Time `json:"created_at"`
	StartedAt    *time.Time `json:"started_at"`
	FinishedAt   *time.Time `json:"finished_at"`
	Name         string     `json:"name"`
	AllowFailure bool       `json:"allow_failure"`
	Coverage     float64    `json:"coverage"`
	PipelineID   int64      `json:"pipeline_id"`
	Author       Author     `json:"author"`
	Description  string     `json:"description"`
	TargetURL    string     `json:"target_url"`
}

CommitStatus represents a GitLab commit status.

GitLab API docs: https://docs.gitlab.com/api/commits/#commit-status

type CommitsService 

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

CommitsService handles communication with the commit related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/commits/

func (*CommitsService) CherryPickCommit added in v0.4.1 

func (s *CommitsService) CherryPickCommit(pid any, sha string, opt *CherryPickCommitOptions, options ...RequestOptionFunc) (*Commit, *Response, error)

func (*CommitsService) CreateCommit added in v0.4.1 

func (s *CommitsService) CreateCommit(pid any, opt *CreateCommitOptions, options ...RequestOptionFunc) (*Commit, *Response, error)

func (*CommitsService) GetCommit 

func (s *CommitsService) GetCommit(pid any, sha string, opt *GetCommitOptions, options ...RequestOptionFunc) (*Commit, *Response, error)

func (*CommitsService) GetCommitComments 

func (s *CommitsService) GetCommitComments(pid any, sha string, opt *GetCommitCommentsOptions, options ...RequestOptionFunc) ([]*CommitComment, *Response, error)

func (*CommitsService) GetCommitDiff 

func (s *CommitsService) GetCommitDiff(pid any, sha string, opt *GetCommitDiffOptions, options ...RequestOptionFunc) ([]*Diff, *Response, error)

func (*CommitsService) GetCommitRefs added in v0.10.8 

func (s *CommitsService) GetCommitRefs(pid any, sha string, opt *GetCommitRefsOptions, options ...RequestOptionFunc) ([]*CommitRef, *Response, error)

func (*CommitsService) GetCommitStatuses 

func (s *CommitsService) GetCommitStatuses(pid any, sha string, opt *GetCommitStatusesOptions, options ...RequestOptionFunc) ([]*CommitStatus, *Response, error)

func (*CommitsService) GetGPGSignature added in v0.116.0 

func (s *CommitsService) GetGPGSignature(pid any, sha string, options ...RequestOptionFunc) (*GPGSignature, *Response, error)

func (*CommitsService) ListCommits 

func (s *CommitsService) ListCommits(pid any, opt *ListCommitsOptions, options ...RequestOptionFunc) ([]*Commit, *Response, error)

func (*CommitsService) ListMergeRequestsByCommit added in v0.116.0 

func (s *CommitsService) ListMergeRequestsByCommit(pid any, sha string, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)

func (*CommitsService) PostCommitComment 

func (s *CommitsService) PostCommitComment(pid any, sha string, opt *PostCommitCommentOptions, options ...RequestOptionFunc) (*CommitComment, *Response, error)

func (*CommitsService) RevertCommit added in v0.116.0 

func (s *CommitsService) RevertCommit(pid any, sha string, opt *RevertCommitOptions, options ...RequestOptionFunc) (*Commit, *Response, error)

func (*CommitsService) SetCommitStatus 

func (s *CommitsService) SetCommitStatus(pid any, sha string, opt *SetCommitStatusOptions, options ...RequestOptionFunc) (*CommitStatus, *Response, error)

type CommitsServiceInterface added in v0.126.0 

type CommitsServiceInterface interface {
	// ListCommits gets a list of repository commits in a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#list-repository-commits
	ListCommits(pid any, opt *ListCommitsOptions, options ...RequestOptionFunc) ([]*Commit, *Response, error)

	// GetCommitRefs gets all references (from branches or tags) a commit is pushed to.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#get-references-a-commit-is-pushed-to
	GetCommitRefs(pid any, sha string, opt *GetCommitRefsOptions, options ...RequestOptionFunc) ([]*CommitRef, *Response, error)

	// GetCommit gets a specific commit identified by the commit hash or name of a
	// branch or tag.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#get-a-single-commit
	GetCommit(pid any, sha string, opt *GetCommitOptions, options ...RequestOptionFunc) (*Commit, *Response, error)

	// CreateCommit creates a commit with multiple files and actions.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#create-a-commit-with-multiple-files-and-actions
	CreateCommit(pid any, opt *CreateCommitOptions, options ...RequestOptionFunc) (*Commit, *Response, error)

	// GetCommitDiff gets the diff of a commit in a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#get-the-diff-of-a-commit
	GetCommitDiff(pid any, sha string, opt *GetCommitDiffOptions, options ...RequestOptionFunc) ([]*Diff, *Response, error)

	// GetCommitComments gets the comments of a commit in a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#get-the-comments-of-a-commit
	GetCommitComments(pid any, sha string, opt *GetCommitCommentsOptions, options ...RequestOptionFunc) ([]*CommitComment, *Response, error)

	// PostCommitComment adds a comment to a commit. Optionally you can post
	// comments on a specific line of a commit. Therefore both path, line_new and
	// line_old are required.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#post-comment-to-commit
	PostCommitComment(pid any, sha string, opt *PostCommitCommentOptions, options ...RequestOptionFunc) (*CommitComment, *Response, error)

	// GetCommitStatuses gets the statuses of a commit in a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#list-the-statuses-of-a-commit
	GetCommitStatuses(pid any, sha string, opt *GetCommitStatusesOptions, options ...RequestOptionFunc) ([]*CommitStatus, *Response, error)

	// SetCommitStatus sets the status of a commit in a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#set-the-pipeline-status-of-a-commit
	SetCommitStatus(pid any, sha string, opt *SetCommitStatusOptions, options ...RequestOptionFunc) (*CommitStatus, *Response, error)

	// ListMergeRequestsByCommit gets merge request associated with a commit.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#list-merge-requests-associated-with-a-commit
	ListMergeRequestsByCommit(pid any, sha string, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)

	// CherryPickCommit cherry picks a commit to a given branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#cherry-pick-a-commit
	CherryPickCommit(pid any, sha string, opt *CherryPickCommitOptions, options ...RequestOptionFunc) (*Commit, *Response, error)

	// RevertCommit reverts a commit in a given branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#revert-a-commit
	RevertCommit(pid any, sha string, opt *RevertCommitOptions, options ...RequestOptionFunc) (*Commit, *Response, error)

	// GetGPGSignature gets a GPG signature of a commit.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/commits/#get-signature-of-a-commit
	GetGPGSignature(pid any, sha string, options ...RequestOptionFunc) (*GPGSignature, *Response, error)
}

CommitsService handles communication with the commit related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/commits/

type Compare 

type Compare struct {
	Commit         *Commit   `json:"commit"`
	Commits        []*Commit `json:"commits"`
	Diffs          []*Diff   `json:"diffs"`
	CompareTimeout bool      `json:"compare_timeout"`
	CompareSameRef bool      `json:"compare_same_ref"`
	WebURL         string    `json:"web_url"`
}

Compare represents the result of a comparison of branches, tags or commits.

GitLab API docs: https://docs.gitlab.com/api/repositories/#compare-branches-tags-or-commits

func (Compare) String 

func (c Compare) String() string

type CompareOptions 

type CompareOptions struct {
	From     *string `url:"from,omitempty" json:"from,omitempty"`
	To       *string `url:"to,omitempty" json:"to,omitempty"`
	Straight *bool   `url:"straight,omitempty" json:"straight,omitempty"`
	Unidiff  *bool   `url:"unidiff,omitempty" json:"unidiff,omitempty"`
}

CompareOptions represents the available Compare() options.

GitLab API docs: https://docs.gitlab.com/api/repositories/#compare-branches-tags-or-commits

type CompoundMetrics added in v0.8.1 

type CompoundMetrics struct {
	QueueMetrics
	ProcessMetrics
	JobStats
}

CompoundMetrics represents the GitLab sidekiq compounded stats.

GitLab API docs: https://docs.gitlab.com/api/sidekiq_metrics/#get-a-compound-response-of-all-the-previously-mentioned-metrics

type ConfigProject added in v0.116.0 

type ConfigProject struct {
	ID                int64      `json:"id"`
	Description       string     `json:"description"`
	Name              string     `json:"name"`
	NameWithNamespace string     `json:"name_with_namespace"`
	Path              string     `json:"path"`
	PathWithNamespace string     `json:"path_with_namespace"`
	CreatedAt         *time.Time `json:"created_at"`
}

type ConfigureProjectPullMirrorOptions added in v0.125.0 

type ConfigureProjectPullMirrorOptions struct {
	Enabled                          *bool   `url:"enabled,omitempty" json:"enabled,omitempty"`
	URL                              *string `url:"url,omitempty" json:"url,omitempty"`
	AuthUser                         *string `url:"auth_user,omitempty" json:"auth_user,omitempty"`
	AuthPassword                     *string `url:"auth_password,omitempty" json:"auth_password,omitempty"`
	MirrorTriggerBuilds              *bool   `url:"mirror_trigger_builds,omitempty" json:"mirror_trigger_builds,omitempty"`
	OnlyMirrorProtectedBranches      *bool   `url:"only_mirror_protected_branches,omitempty" json:"only_mirror_protected_branches,omitempty"`
	MirrorOverwritesDivergedBranches *bool   `url:"mirror_overwrites_diverged_branches,omitempty" json:"mirror_overwrites_diverged_branches,omitempty"`
	MirrorBranchRegex                *string `url:"mirror_branch_regex,omitempty" json:"mirror_branch_regex,omitempty"`
}

ConfigureProjectPullMirrorOptions represents the available ConfigureProjectPullMirror() options.

GitLab API docs: https://docs.gitlab.com/api/project_pull_mirroring/#configure-pull-mirroring-for-a-project

type ContainerExpirationPolicy added in v0.116.0 

type ContainerExpirationPolicy struct {
	Cadence         string     `json:"cadence"`
	KeepN           int64      `json:"keep_n"`
	OlderThan       string     `json:"older_than"`
	NameRegexDelete string     `json:"name_regex_delete"`
	NameRegexKeep   string     `json:"name_regex_keep"`
	Enabled         bool       `json:"enabled"`
	NextRunAt       *time.Time `json:"next_run_at"`

	// Deprecated: use NameRegexDelete instead
	NameRegex string `json:"name_regex"`
}

ContainerExpirationPolicy represents the container expiration policy.

type ContainerExpirationPolicyAttributes added in v0.116.0 

type ContainerExpirationPolicyAttributes struct {
	Cadence         *string `url:"cadence,omitempty" json:"cadence,omitempty"`
	KeepN           *int64  `url:"keep_n,omitempty" json:"keep_n,omitempty"`
	OlderThan       *string `url:"older_than,omitempty" json:"older_than,omitempty"`
	NameRegexDelete *string `url:"name_regex_delete,omitempty" json:"name_regex_delete,omitempty"`
	NameRegexKeep   *string `url:"name_regex_keep,omitempty" json:"name_regex_keep,omitempty"`
	Enabled         *bool   `url:"enabled,omitempty" json:"enabled,omitempty"`

	// Deprecated: Is replaced by NameRegexDelete and is internally hardwired to its value.
	NameRegex *string `url:"name_regex,omitempty" json:"name_regex,omitempty"`
}

ContainerExpirationPolicyAttributes represents the available container expiration policy attributes.

GitLab API docs: https://docs.gitlab.com/api/projects/#create-a-project

type ContainerRegistryProtectionRule added in v0.127.0 

type ContainerRegistryProtectionRule struct {
	ID                          int64                     `json:"id"`
	ProjectID                   int64                     `json:"project_id"`
	RepositoryPathPattern       string                    `json:"repository_path_pattern"`
	MinimumAccessLevelForPush   ProtectionRuleAccessLevel `json:"minimum_access_level_for_push"`
	MinimumAccessLevelForDelete ProtectionRuleAccessLevel `json:"minimum_access_level_for_delete"`
}

ContainerRegistryProtectionRule represents a GitLab container registry protection rule.

GitLab API docs: https://docs.gitlab.com/api/container_repository_protection_rules/

func (ContainerRegistryProtectionRule) String added in v0.127.0 

func (s ContainerRegistryProtectionRule) String() string

type ContainerRegistryProtectionRulesService added in v0.127.0 

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

ContainerRegistryProtectionRulesService handles communication with the container registry protection rules related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/container_repository_protection_rules/

func (*ContainerRegistryProtectionRulesService) CreateContainerRegistryProtectionRule added in v0.127.0 

func (s *ContainerRegistryProtectionRulesService) CreateContainerRegistryProtectionRule(pid any, opt *CreateContainerRegistryProtectionRuleOptions, options ...RequestOptionFunc) (*ContainerRegistryProtectionRule, *Response, error)

func (*ContainerRegistryProtectionRulesService) DeleteContainerRegistryProtectionRule added in v0.127.0 

func (s *ContainerRegistryProtectionRulesService) DeleteContainerRegistryProtectionRule(pid any, ruleID int64, options ...RequestOptionFunc) (*Response, error)

func (*ContainerRegistryProtectionRulesService) ListContainerRegistryProtectionRules added in v0.127.0 

func (s *ContainerRegistryProtectionRulesService) ListContainerRegistryProtectionRules(pid any, options ...RequestOptionFunc) ([]*ContainerRegistryProtectionRule, *Response, error)

func (*ContainerRegistryProtectionRulesService) UpdateContainerRegistryProtectionRule added in v0.127.0 

func (s *ContainerRegistryProtectionRulesService) UpdateContainerRegistryProtectionRule(pid any, ruleID int64, opt *UpdateContainerRegistryProtectionRuleOptions, options ...RequestOptionFunc) (*ContainerRegistryProtectionRule, *Response, error)

type ContainerRegistryProtectionRulesServiceInterface added in v0.127.0 

type ContainerRegistryProtectionRulesServiceInterface interface {
	// ListContainerRegistryProtectionRules gets a list of container repository
	// protection rules from a project’s container registry.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_repository_protection_rules/#list-container-repository-protection-rules
	// ListContainerRegistryProtectionRules gets a list of container repository
	// protection rules from a project’s container registry.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_repository_protection_rules/#list-container-repository-protection-rules
	ListContainerRegistryProtectionRules(pid any, options ...RequestOptionFunc) ([]*ContainerRegistryProtectionRule, *Response, error)

	// CreateContainerRegistryProtectionRule creates a container repository
	// protection rule for a project’s container registry.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_repository_protection_rules/#create-a-container-repository-protection-rule
	CreateContainerRegistryProtectionRule(pid any, opt *CreateContainerRegistryProtectionRuleOptions, options ...RequestOptionFunc) (*ContainerRegistryProtectionRule, *Response, error)

	// UpdateContainerRegistryProtectionRule updates a container repository protection
	// rule for a project’s container registry.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_repository_protection_rules/#update-a-container-repository-protection-rule
	UpdateContainerRegistryProtectionRule(pid any, ruleID int64, opt *UpdateContainerRegistryProtectionRuleOptions, options ...RequestOptionFunc) (*ContainerRegistryProtectionRule, *Response, error)

	// DeleteContainerRegistryProtectionRule deletes a container repository protection
	// rule from a project’s container registry.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_repository_protection_rules/#delete-a-container-repository-protection-rule
	DeleteContainerRegistryProtectionRule(pid any, ruleID int64, options ...RequestOptionFunc) (*Response, error)
}

type ContainerRegistryService added in v0.116.0 

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

ContainerRegistryService handles communication with the container registry related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/container_registry/

func (*ContainerRegistryService) DeleteRegistryRepository added in v0.116.0 

func (s *ContainerRegistryService) DeleteRegistryRepository(pid any, repository int64, options ...RequestOptionFunc) (*Response, error)

func (*ContainerRegistryService) DeleteRegistryRepositoryTag added in v0.116.0 

func (s *ContainerRegistryService) DeleteRegistryRepositoryTag(pid any, repository int64, tagName string, options ...RequestOptionFunc) (*Response, error)

func (*ContainerRegistryService) DeleteRegistryRepositoryTags added in v0.116.0 

func (s *ContainerRegistryService) DeleteRegistryRepositoryTags(pid any, repository int64, opt *DeleteRegistryRepositoryTagsOptions, options ...RequestOptionFunc) (*Response, error)

func (*ContainerRegistryService) GetRegistryRepositoryTagDetail added in v0.116.0 

func (s *ContainerRegistryService) GetRegistryRepositoryTagDetail(pid any, repository int64, tagName string, options ...RequestOptionFunc) (*RegistryRepositoryTag, *Response, error)

func (*ContainerRegistryService) GetSingleRegistryRepository added in v0.116.0 

func (s *ContainerRegistryService) GetSingleRegistryRepository(pid any, opt *GetSingleRegistryRepositoryOptions, options ...RequestOptionFunc) (*RegistryRepository, *Response, error)

func (*ContainerRegistryService) ListGroupRegistryRepositories added in v0.116.0 

func (s *ContainerRegistryService) ListGroupRegistryRepositories(gid any, opt *ListGroupRegistryRepositoriesOptions, options ...RequestOptionFunc) ([]*RegistryRepository, *Response, error)

func (*ContainerRegistryService) ListProjectRegistryRepositories added in v0.116.0 

func (s *ContainerRegistryService) ListProjectRegistryRepositories(pid any, opt *ListProjectRegistryRepositoriesOptions, options ...RequestOptionFunc) ([]*RegistryRepository, *Response, error)

func (*ContainerRegistryService) ListRegistryRepositoryTags added in v0.116.0 

func (s *ContainerRegistryService) ListRegistryRepositoryTags(pid any, repository int64, opt *ListRegistryRepositoryTagsOptions, options ...RequestOptionFunc) ([]*RegistryRepositoryTag, *Response, error)

type ContainerRegistryServiceInterface added in v0.126.0 

type ContainerRegistryServiceInterface interface {
	// ListProjectRegistryRepositories gets a list of registry repositories in a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_registry/#within-a-project
	ListProjectRegistryRepositories(pid any, opt *ListProjectRegistryRepositoriesOptions, options ...RequestOptionFunc) ([]*RegistryRepository, *Response, error)

	// ListGroupRegistryRepositories gets a list of registry repositories in a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_registry/#within-a-group
	ListGroupRegistryRepositories(gid any, opt *ListGroupRegistryRepositoriesOptions, options ...RequestOptionFunc) ([]*RegistryRepository, *Response, error)

	// GetSingleRegistryRepository gets the details of single registry repository.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_registry/#get-details-of-a-single-repository
	GetSingleRegistryRepository(pid any, opt *GetSingleRegistryRepositoryOptions, options ...RequestOptionFunc) (*RegistryRepository, *Response, error)

	// DeleteRegistryRepository deletes a repository in a registry.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_registry/#delete-registry-repository
	DeleteRegistryRepository(pid any, repository int64, options ...RequestOptionFunc) (*Response, error)

	// ListRegistryRepositoryTags gets a list of tags for given registry repository.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_registry/#list-registry-repository-tags
	ListRegistryRepositoryTags(pid any, repository int64, opt *ListRegistryRepositoryTagsOptions, options ...RequestOptionFunc) ([]*RegistryRepositoryTag, *Response, error)

	// GetRegistryRepositoryTagDetail get details of a registry repository tag.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_registry/#get-details-of-a-registry-repository-tag
	GetRegistryRepositoryTagDetail(pid any, repository int64, tagName string, options ...RequestOptionFunc) (*RegistryRepositoryTag, *Response, error)

	// DeleteRegistryRepositoryTag deletes a registry repository tag.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_registry/#delete-a-registry-repository-tag
	DeleteRegistryRepositoryTag(pid any, repository int64, tagName string, options ...RequestOptionFunc) (*Response, error)

	// DeleteRegistryRepositoryTags deletes repository tags in bulk based on given criteria.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/container_registry/#delete-registry-repository-tags-in-bulk
	DeleteRegistryRepositoryTags(pid any, repository int64, opt *DeleteRegistryRepositoryTagsOptions, options ...RequestOptionFunc) (*Response, error)
}

type ContainerRegistryStatus added in v0.116.0 

type ContainerRegistryStatus string

ContainerRegistryStatus represents the status of a Container Registry.

GitLab API docs: https://docs.gitlab.com/api/container_registry/#list-registry-repositories 

const (
	ContainerRegistryStatusDeleteScheduled ContainerRegistryStatus = "delete_scheduled"
	ContainerRegistryStatusDeleteFailed    ContainerRegistryStatus = "delete_failed"
	ContainerRegistryStatusDeleteOngoing   ContainerRegistryStatus = "delete_ongoing"
)

ContainerRegistryStatus represents all valid statuses of a Container Registry.

Undocumented, see code at: https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/models/container_repository.rb?ref_type=heads#L35

type ContributionEvent added in v0.8.0 

type ContributionEvent struct {
	ID             int64                     `json:"id"`
	Title          string                    `json:"title"`
	ProjectID      int64                     `json:"project_id"`
	ActionName     string                    `json:"action_name"`
	TargetID       int64                     `json:"target_id"`
	TargetIID      int64                     `json:"target_iid"`
	TargetType     string                    `json:"target_type"`
	AuthorID       int64                     `json:"author_id"`
	TargetTitle    string                    `json:"target_title"`
	CreatedAt      *time.Time                `json:"created_at"`
	PushData       ContributionEventPushData `json:"push_data"`
	Note           *Note                     `json:"note"`
	Author         BasicUser                 `json:"author"`
	AuthorUsername string                    `json:"author_username"`
}

ContributionEvent represents a user's contribution

GitLab API docs: https://docs.gitlab.com/api/events/#get-user-contribution-events

type ContributionEventPushData added in v1.0.0 

type ContributionEventPushData struct {
	CommitCount int64  `json:"commit_count"`
	Action      string `json:"action"`
	RefType     string `json:"ref_type"`
	CommitFrom  string `json:"commit_from"`
	CommitTo    string `json:"commit_to"`
	Ref         string `json:"ref"`
	CommitTitle string `json:"commit_title"`
}

ContributionEventPushData represents a user's contribution push data.

GitLab API docs: https://docs.gitlab.com/api/events/#get-contribution-events-for-a-user

type Contributor 

type Contributor struct {
	Name      string `json:"name"`
	Email     string `json:"email"`
	Commits   int64  `json:"commits"`
	Additions int64  `json:"additions"`
	Deletions int64  `json:"deletions"`
}

Contributor represents a GitLab contributor.

GitLab API docs: https://docs.gitlab.com/api/repositories/#contributors

func (Contributor) String 

func (c Contributor) String() string

type CreateAgentTokenOptions added in v0.116.0 

type CreateAgentTokenOptions struct {
	Name        *string `url:"name,omitempty" json:"name,omitempty"`
	Description *string `url:"description,omitempty" json:"description,omitempty"`
}

CreateAgentTokenOptions represents the available CreateAgentToken() options.

GitLab API docs: https://docs.gitlab.com/api/cluster_agents/#create-an-agent-token

type CreateApplicationOptions added in v0.116.0 

type CreateApplicationOptions struct {
	Name         *string `url:"name,omitempty" json:"name,omitempty"`
	RedirectURI  *string `url:"redirect_uri,omitempty" json:"redirect_uri,omitempty"`
	Scopes       *string `url:"scopes,omitempty" json:"scopes,omitempty"`
	Confidential *bool   `url:"confidential,omitempty" json:"confidential,omitempty"`
}

CreateApplicationOptions represents the available CreateApplication() options.

GitLab API docs: https://docs.gitlab.com/api/applications/#create-an-application

type CreateAwardEmojiOptions added in v0.10.6 

type CreateAwardEmojiOptions struct {
	Name string `json:"name"`
}

CreateAwardEmojiOptions represents the available options for awarding emoji for a resource

GitLab API docs: https://docs.gitlab.com/api/emoji_reactions/#add-a-new-emoji-reaction

type CreateBranchOptions 

type CreateBranchOptions struct {
	Branch *string `url:"branch,omitempty" json:"branch,omitempty"`
	Ref    *string `url:"ref,omitempty" json:"ref,omitempty"`
}

CreateBranchOptions represents the available CreateBranch() options.

GitLab API docs: https://docs.gitlab.com/api/branches/#create-repository-branch

type CreateBroadcastMessageOptions added in v0.8.1 

type CreateBroadcastMessageOptions struct {
	Message            *string            `url:"message" json:"message"`
	StartsAt           *time.Time         `url:"starts_at,omitempty" json:"starts_at,omitempty"`
	EndsAt             *time.Time         `url:"ends_at,omitempty" json:"ends_at,omitempty"`
	Font               *string            `url:"font,omitempty" json:"font,omitempty"`
	TargetAccessLevels []AccessLevelValue `url:"target_access_levels,omitempty" json:"target_access_levels,omitempty"`
	TargetPath         *string            `url:"target_path,omitempty" json:"target_path,omitempty"`
	BroadcastType      *string            `url:"broadcast_type,omitempty" json:"broadcast_type,omitempty"`
	Dismissable        *bool              `url:"dismissable,omitempty" json:"dismissable,omitempty"`
	Theme              *string            `url:"theme,omitempty" json:"theme,omitempty"`
}

CreateBroadcastMessageOptions represents the available CreateBroadcastMessage() options.

GitLab API docs: https://docs.gitlab.com/api/broadcast_messages/#create-a-broadcast-message

type CreateCommitDiscussionOptions added in v0.11.2 

type CreateCommitDiscussionOptions struct {
	Body      *string       `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time    `url:"created_at,omitempty" json:"created_at,omitempty"`
	Position  *NotePosition `url:"position,omitempty" json:"position,omitempty"`
}

CreateCommitDiscussionOptions represents the available CreateCommitDiscussion() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#create-new-commit-thread

type CreateCommitOptions added in v0.4.1 

type CreateCommitOptions struct {
	Branch        *string                `url:"branch,omitempty" json:"branch,omitempty"`
	CommitMessage *string                `url:"commit_message,omitempty" json:"commit_message,omitempty"`
	StartBranch   *string                `url:"start_branch,omitempty" json:"start_branch,omitempty"`
	StartSHA      *string                `url:"start_sha,omitempty" json:"start_sha,omitempty"`
	StartProject  *string                `url:"start_project,omitempty" json:"start_project,omitempty"`
	Actions       []*CommitActionOptions `url:"actions" json:"actions"`
	AuthorEmail   *string                `url:"author_email,omitempty" json:"author_email,omitempty"`
	AuthorName    *string                `url:"author_name,omitempty" json:"author_name,omitempty"`
	Stats         *bool                  `url:"stats,omitempty" json:"stats,omitempty"`
	Force         *bool                  `url:"force,omitempty" json:"force,omitempty"`
}

CreateCommitOptions represents the available options for a new commit.

GitLab API docs: https://docs.gitlab.com/api/commits/#create-a-commit-with-multiple-files-and-actions

type CreateContainerRegistryProtectionRuleOptions added in v0.127.0 

type CreateContainerRegistryProtectionRuleOptions struct {
	RepositoryPathPattern       *string                    `url:"repository_path_pattern,omitempty" json:"repository_path_pattern,omitempty"`
	MinimumAccessLevelForPush   *ProtectionRuleAccessLevel `url:"minimum_access_level_for_push,omitempty" json:"minimum_access_level_for_push,omitempty"`
	MinimumAccessLevelForDelete *ProtectionRuleAccessLevel `url:"minimum_access_level_for_delete,omitempty" json:"minimum_access_level_for_delete,omitempty"`
}

CreateContainerRegistryProtectionRuleOptions represents the available CreateContainerRegistryProtectionRule() options.

GitLab API docs: https://docs.gitlab.com/api/container_repository_protection_rules/#create-a-container-repository-protection-rule

type CreateDependencyListExportOptions added in v0.116.0 

type CreateDependencyListExportOptions struct {
	ExportType *string `url:"export_type" json:"export_type"`
}

CreateDependencyListExportOptions represents the available CreateDependencyListExport() options.

GitLab API docs: https://docs.gitlab.com/api/dependency_list_export/#create-a-dependency-list-export

type CreateDraftNoteOptions added in v0.116.0 

type CreateDraftNoteOptions struct {
	Note                  *string          `url:"note" json:"note"`
	CommitID              *string          `url:"commit_id,omitempty" json:"commit_id,omitempty"`
	InReplyToDiscussionID *string          `url:"in_reply_to_discussion_id,omitempty" json:"in_reply_to_discussion_id,omitempty"`
	ResolveDiscussion     *bool            `url:"resolve_discussion,omitempty" json:"resolve_discussion,omitempty"`
	Position              *PositionOptions `url:"position,omitempty" json:"position,omitempty"`
}

CreateDraftNoteOptions represents the available CreateDraftNote() options.

GitLab API docs: GitLab API docs: https://docs.gitlab.com/api/draft_notes/#create-a-draft-note

type CreateEnvironmentOptions added in v0.7.0 

type CreateEnvironmentOptions struct {
	Name                *string `url:"name,omitempty" json:"name,omitempty"`
	Description         *string `url:"description,omitempty" json:"description,omitempty"`
	ExternalURL         *string `url:"external_url,omitempty" json:"external_url,omitempty"`
	Tier                *string `url:"tier,omitempty" json:"tier,omitempty"`
	ClusterAgentID      *int64  `url:"cluster_agent_id,omitempty" json:"cluster_agent_id,omitempty"`
	KubernetesNamespace *string `url:"kubernetes_namespace,omitempty" json:"kubernetes_namespace,omitempty"`
	FluxResourcePath    *string `url:"flux_resource_path,omitempty" json:"flux_resource_path,omitempty"`
	AutoStopSetting     *string `url:"auto_stop_setting,omitempty" json:"auto_stop_setting,omitempty"`
}

CreateEnvironmentOptions represents the available CreateEnvironment() options.

GitLab API docs: https://docs.gitlab.com/api/environments/#create-a-new-environment

type CreateEpicDiscussionOptions added in v0.11.2 

type CreateEpicDiscussionOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
}

CreateEpicDiscussionOptions represents the available CreateEpicDiscussion() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#create-new-epic-thread

type CreateEpicNoteOptions added in v0.116.0 

type CreateEpicNoteOptions struct {
	Body *string `url:"body,omitempty" json:"body,omitempty"`
}

CreateEpicNoteOptions represents the available CreateEpicNote() options. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/notes/#create-new-epic-note

type CreateEpicOptions added in v0.116.0 

type CreateEpicOptions struct {
	Title            *string       `url:"title,omitempty" json:"title,omitempty"`
	Labels           *LabelOptions `url:"labels,comma,omitempty" json:"labels,omitempty"`
	Description      *string       `url:"description,omitempty" json:"description,omitempty"`
	Color            *string       `url:"color,omitempty" json:"color,omitempty"`
	Confidential     *bool         `url:"confidential,omitempty" json:"confidential,omitempty"`
	CreatedAt        *time.Time    `url:"created_at,omitempty" json:"created_at,omitempty"`
	StartDateIsFixed *bool         `url:"start_date_is_fixed,omitempty" json:"start_date_is_fixed,omitempty"`
	StartDateFixed   *ISOTime      `url:"start_date_fixed,omitempty" json:"start_date_fixed,omitempty"`
	DueDateIsFixed   *bool         `url:"due_date_is_fixed,omitempty" json:"due_date_is_fixed,omitempty"`
	DueDateFixed     *ISOTime      `url:"due_date_fixed,omitempty" json:"due_date_fixed,omitempty"`
	ParentID         *int64        `url:"parent_id,omitempty" json:"parent_id,omitempty"`
}

CreateEpicOptions represents the available CreateEpic() options. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epics/#new-epic

type CreateExternalStatusCheckOptions added in v0.116.0 

type CreateExternalStatusCheckOptions struct {
	Name               *string  `url:"name,omitempty" json:"name,omitempty"`
	ExternalURL        *string  `url:"external_url,omitempty" json:"external_url,omitempty"`
	ProtectedBranchIDs *[]int64 `url:"protected_branch_ids,omitempty" json:"protected_branch_ids,omitempty"`
}

CreateExternalStatusCheckOptions represents the available CreateExternalStatusCheck() options. Deprecated: to be removed in 1.0; use CreateProjectExternalStatusCheckOptions instead

GitLab API docs: https://docs.gitlab.com/api/status_checks/#create-external-status-check-service

type CreateFeatureFlagUserListOptions added in v0.128.0 

type CreateFeatureFlagUserListOptions struct {
	Name     string `url:"name,omitempty" json:"name,omitempty"`
	UserXIDs string `url:"user_xids,omitempty" json:"user_xids,omitempty"`
}

CreateFeatureFlagUserListOptions represents the available CreateFeatureFlagUserList() options.

GitLab API docs: https://docs.gitlab.com/api/feature_flag_user_lists/#create-a-feature-flag-user-list

type CreateFileOptions 

type CreateFileOptions struct {
	Branch          *string `url:"branch,omitempty" json:"branch,omitempty"`
	StartBranch     *string `url:"start_branch,omitempty" json:"start_branch,omitempty"`
	Encoding        *string `url:"encoding,omitempty" json:"encoding,omitempty"`
	AuthorEmail     *string `url:"author_email,omitempty" json:"author_email,omitempty"`
	AuthorName      *string `url:"author_name,omitempty" json:"author_name,omitempty"`
	Content         *string `url:"content,omitempty" json:"content,omitempty"`
	CommitMessage   *string `url:"commit_message,omitempty" json:"commit_message,omitempty"`
	ExecuteFilemode *bool   `url:"execute_filemode,omitempty" json:"execute_filemode,omitempty"`
}

CreateFileOptions represents the available CreateFile() options.

GitLab API docs: https://docs.gitlab.com/api/repository_files/#create-new-file-in-repository

type CreateFreezePeriodOptions added in v0.116.0 

type CreateFreezePeriodOptions struct {
	FreezeStart  *string `url:"freeze_start,omitempty" json:"freeze_start,omitempty"`
	FreezeEnd    *string `url:"freeze_end,omitempty" json:"freeze_end,omitempty"`
	CronTimezone *string `url:"cron_timezone,omitempty" json:"cron_timezone,omitempty"`
}

CreateFreezePeriodOptions represents the available CreateFreezePeriodOptions() options.

GitLab API docs: https://docs.gitlab.com/api/freeze_periods/#create-a-freeze-period

type CreateGeoNodesOptions added in v0.116.0 

type CreateGeoNodesOptions struct {
	Primary                          *bool     `url:"primary,omitempty" json:"primary,omitempty"`
	Enabled                          *bool     `url:"enabled,omitempty" json:"enabled,omitempty"`
	Name                             *string   `url:"name,omitempty" json:"name,omitempty"`
	URL                              *string   `url:"url,omitempty" json:"url,omitempty"`
	InternalURL                      *string   `url:"internal_url,omitempty" json:"internal_url,omitempty"`
	FilesMaxCapacity                 *int64    `url:"files_max_capacity,omitempty" json:"files_max_capacity,omitempty"`
	ReposMaxCapacity                 *int64    `url:"repos_max_capacity,omitempty" json:"repos_max_capacity,omitempty"`
	VerificationMaxCapacity          *int64    `url:"verification_max_capacity,omitempty" json:"verification_max_capacity,omitempty"`
	ContainerRepositoriesMaxCapacity *int64    `url:"container_repositories_max_capacity,omitempty" json:"container_repositories_max_capacity,omitempty"`
	SyncObjectStorage                *bool     `url:"sync_object_storage,omitempty" json:"sync_object_storage,omitempty"`
	SelectiveSyncType                *string   `url:"selective_sync_type,omitempty" json:"selective_sync_type,omitempty"`
	SelectiveSyncShards              *[]string `url:"selective_sync_shards,omitempty" json:"selective_sync_shards,omitempty"`
	SelectiveSyncNamespaceIDs        *[]int64  `url:"selective_sync_namespace_ids,omitempty" json:"selective_sync_namespace_ids,omitempty"`
	MinimumReverificationInterval    *int64    `url:"minimum_reverification_interval,omitempty" json:"minimum_reverification_interval,omitempty"`
}

CreateGeoNodesOptions represents the available CreateGeoNode() options. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#create-a-new-geo-node

type CreateGeoSitesOptions added in v0.128.0 

type CreateGeoSitesOptions struct {
	Primary                          *bool     `url:"primary,omitempty" json:"primary,omitempty"`
	Enabled                          *bool     `url:"enabled,omitempty" json:"enabled,omitempty"`
	Name                             *string   `url:"name,omitempty" json:"name,omitempty"`
	URL                              *string   `url:"url,omitempty" json:"url,omitempty"`
	InternalURL                      *string   `url:"internal_url,omitempty" json:"internal_url,omitempty"`
	FilesMaxCapacity                 *int64    `url:"files_max_capacity,omitempty" json:"files_max_capacity,omitempty"`
	ReposMaxCapacity                 *int64    `url:"repos_max_capacity,omitempty" json:"repos_max_capacity,omitempty"`
	VerificationMaxCapacity          *int64    `url:"verification_max_capacity,omitempty" json:"verification_max_capacity,omitempty"`
	ContainerRepositoriesMaxCapacity *int64    `url:"container_repositories_max_capacity,omitempty" json:"container_repositories_max_capacity,omitempty"`
	SyncObjectStorage                *bool     `url:"sync_object_storage,omitempty" json:"sync_object_storage,omitempty"`
	SelectiveSyncType                *string   `url:"selective_sync_type,omitempty" json:"selective_sync_type,omitempty"`
	SelectiveSyncShards              *[]string `url:"selective_sync_shards,omitempty" json:"selective_sync_shards,omitempty"`
	SelectiveSyncNamespaceIDs        *[]int64  `url:"selective_sync_namespace_ids,omitempty" json:"selective_sync_namespace_ids,omitempty"`
	MinimumReverificationInterval    *int64    `url:"minimum_reverification_interval,omitempty" json:"minimum_reverification_interval,omitempty"`
}

CreateGeoSitesOptions represents the available CreateGeoSite() options.

GitLab API docs: https://docs.gitlab.com/api/geo_sites/#create-a-geo-site

type CreateGroupAccessTokenOptions added in v0.116.0 

type CreateGroupAccessTokenOptions struct {
	Name        *string           `url:"name,omitempty" json:"name,omitempty"`
	Description *string           `url:"description,omitempty" json:"description,omitempty"`
	Scopes      *[]string         `url:"scopes,omitempty" json:"scopes,omitempty"`
	AccessLevel *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	ExpiresAt   *ISOTime          `url:"expires_at,omitempty" json:"expires_at,omitempty"`
}

CreateGroupAccessTokenOptions represents the available CreateVariable() options.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#create-a-group-access-token

type CreateGroupDeployTokenOptions added in v0.116.0 

type CreateGroupDeployTokenOptions struct {
	Name      *string    `url:"name,omitempty" json:"name,omitempty"`
	ExpiresAt *time.Time `url:"expires_at,omitempty" json:"expires_at,omitempty"`
	Username  *string    `url:"username,omitempty" json:"username,omitempty"`
	Scopes    *[]string  `url:"scopes,omitempty" json:"scopes,omitempty"`
}

CreateGroupDeployTokenOptions represents the available CreateGroupDeployToken() options.

GitLab API docs: https://docs.gitlab.com/api/deploy_tokens/#create-a-group-deploy-token

type CreateGroupIssueBoardListOptions added in v0.11.0 

type CreateGroupIssueBoardListOptions struct {
	LabelID *int64 `url:"label_id" json:"label_id"`
}

CreateGroupIssueBoardListOptions represents the available CreateGroupIssueBoardList() options.

GitLab API docs: https://docs.gitlab.com/api/group_boards/#new-group-issue-board-list

type CreateGroupIssueBoardOptions added in v0.116.0 

type CreateGroupIssueBoardOptions struct {
	Name *string `url:"name" json:"name"`
}

CreateGroupIssueBoardOptions represents the available CreateGroupIssueBoard() options.

GitLab API docs: https://docs.gitlab.com/api/group_boards/#create-a-group-issue-board

type CreateGroupLabelOptions added in v0.116.0 

type CreateGroupLabelOptions struct {
	Name        *string `url:"name,omitempty" json:"name,omitempty"`
	Color       *string `url:"color,omitempty" json:"color,omitempty"`
	Description *string `url:"description,omitempty" json:"description,omitempty"`
	Priority    *int64  `url:"priority,omitempty" json:"priority,omitempty"`
}

CreateGroupLabelOptions represents the available CreateGroupLabel() options.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#create-a-new-group-label

type CreateGroupMilestoneOptions added in v0.10.0 

type CreateGroupMilestoneOptions struct {
	Title       *string  `url:"title,omitempty" json:"title,omitempty"`
	Description *string  `url:"description,omitempty" json:"description,omitempty"`
	StartDate   *ISOTime `url:"start_date,omitempty" json:"start_date,omitempty"`
	DueDate     *ISOTime `url:"due_date,omitempty" json:"due_date,omitempty"`
}

CreateGroupMilestoneOptions represents the available CreateGroupMilestone() options.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#create-new-milestone

type CreateGroupOptions 

type CreateGroupOptions struct {
	Name                            *string                                 `url:"name,omitempty" json:"name,omitempty"`
	Path                            *string                                 `url:"path,omitempty" json:"path,omitempty"`
	Avatar                          *GroupAvatar                            `url:"-" json:"-"`
	DefaultBranch                   *string                                 `url:"default_branch,omitempty" json:"default_branch,omitempty"`
	Description                     *string                                 `url:"description,omitempty" json:"description,omitempty"`
	MembershipLock                  *bool                                   `url:"membership_lock,omitempty" json:"membership_lock,omitempty"`
	Visibility                      *VisibilityValue                        `url:"visibility,omitempty" json:"visibility,omitempty"`
	ShareWithGroupLock              *bool                                   `url:"share_with_group_lock,omitempty" json:"share_with_group_lock,omitempty"`
	RequireTwoFactorAuth            *bool                                   `url:"require_two_factor_authentication,omitempty" json:"require_two_factor_authentication,omitempty"`
	TwoFactorGracePeriod            *int64                                  `url:"two_factor_grace_period,omitempty" json:"two_factor_grace_period,omitempty"`
	ProjectCreationLevel            *ProjectCreationLevelValue              `url:"project_creation_level,omitempty" json:"project_creation_level,omitempty"`
	AutoDevopsEnabled               *bool                                   `url:"auto_devops_enabled,omitempty" json:"auto_devops_enabled,omitempty"`
	SubGroupCreationLevel           *SubGroupCreationLevelValue             `url:"subgroup_creation_level,omitempty" json:"subgroup_creation_level,omitempty"`
	EmailsEnabled                   *bool                                   `url:"emails_enabled,omitempty" json:"emails_enabled,omitempty"`
	MentionsDisabled                *bool                                   `url:"mentions_disabled,omitempty" json:"mentions_disabled,omitempty"`
	LFSEnabled                      *bool                                   `url:"lfs_enabled,omitempty" json:"lfs_enabled,omitempty"`
	DefaultBranchProtectionDefaults *DefaultBranchProtectionDefaultsOptions `url:"default_branch_protection_defaults,omitempty" json:"default_branch_protection_defaults,omitempty"`
	RequestAccessEnabled            *bool                                   `url:"request_access_enabled,omitempty" json:"request_access_enabled,omitempty"`
	ParentID                        *int64                                  `url:"parent_id,omitempty" json:"parent_id,omitempty"`
	SharedRunnersMinutesLimit       *int64                                  `url:"shared_runners_minutes_limit,omitempty" json:"shared_runners_minutes_limit,omitempty"`
	ExtraSharedRunnersMinutesLimit  *int64                                  `url:"extra_shared_runners_minutes_limit,omitempty" json:"extra_shared_runners_minutes_limit,omitempty"`
	WikiAccessLevel                 *AccessControlValue                     `url:"wiki_access_level,omitempty" json:"wiki_access_level,omitempty"`

	// Deprecated: Use EmailsEnabled instead
	EmailsDisabled *bool `url:"emails_disabled,omitempty" json:"emails_disabled,omitempty"`

	// Deprecated: User DefaultBranchProtectionDefaults instead
	DefaultBranchProtection *int64 `url:"default_branch_protection,omitempty" json:"default_branch_protection,omitempty"`

	EnabledGitAccessProtocol  *EnabledGitAccessProtocolValue `url:"enabled_git_access_protocol,omitempty" json:"enabled_git_access_protocol,omitempty"`
	OrganizationID            *int64                         `url:"organization_id,omitempty" json:"organization_id,omitempty"`
	DuoAvailability           *DuoAvailabilityValue          `url:"duo_availability,omitempty" json:"duo_availability,omitempty"`
	ExperimentFeaturesEnabled *bool                          `url:"experiment_features_enabled,omitempty" json:"experiment_features_enabled,omitempty"`
}

CreateGroupOptions represents the available CreateGroup() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#create-a-group

type CreateGroupSSHCertificateOptions added in v0.116.0 

type CreateGroupSSHCertificateOptions struct {
	Key   *string `url:"key,omitempty" json:"key,omitempty"`
	Title *string `url:"title,omitempty" json:"title,omitempty"`
}

CreateGroupSSHCertificateOptions represents the available CreateGroupSSHCertificate() options.

GitLab API docs: https://docs.gitlab.com/api/group_ssh_certificates/#create-ssh-certificate

type CreateGroupVariableOptions added in v0.116.0 

type CreateGroupVariableOptions struct {
	Key              *string            `url:"key,omitempty" json:"key,omitempty"`
	Value            *string            `url:"value,omitempty" json:"value,omitempty"`
	Description      *string            `url:"description,omitempty" json:"description,omitempty"`
	EnvironmentScope *string            `url:"environment_scope,omitempty" json:"environment_scope,omitempty"`
	Masked           *bool              `url:"masked,omitempty" json:"masked,omitempty"`
	MaskedAndHidden  *bool              `url:"masked_and_hidden,omitempty" json:"masked_and_hidden,omitempty"`
	Protected        *bool              `url:"protected,omitempty" json:"protected,omitempty"`
	Raw              *bool              `url:"raw,omitempty" json:"raw,omitempty"`
	VariableType     *VariableTypeValue `url:"variable_type,omitempty" json:"variable_type,omitempty"`
}

CreateGroupVariableOptions represents the available CreateVariable() options.

GitLab API docs: https://docs.gitlab.com/api/group_level_variables/#create-variable

type CreateGroupWikiPageOptions added in v0.116.0 

type CreateGroupWikiPageOptions struct {
	Content *string          `url:"content,omitempty" json:"content,omitempty"`
	Title   *string          `url:"title,omitempty" json:"title,omitempty"`
	Format  *WikiFormatValue `url:"format,omitempty" json:"format,omitempty"`
}

CreateGroupWikiPageOptions represents options to CreateGroupWikiPage.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/#create-a-new-wiki-page

type CreateImpersonationTokenOptions added in v0.6.0 

type CreateImpersonationTokenOptions struct {
	Name      *string    `url:"name,omitempty" json:"name,omitempty"`
	Scopes    *[]string  `url:"scopes,omitempty" json:"scopes,omitempty"`
	ExpiresAt *time.Time `url:"expires_at,omitempty" json:"expires_at,omitempty"`
}

CreateImpersonationTokenOptions represents the available CreateImpersonationToken() options.

GitLab API docs: https://docs.gitlab.com/api/user_tokens/#create-an-impersonation-token

type CreateInstanceVariableOptions added in v0.116.0 

type CreateInstanceVariableOptions struct {
	Key          *string            `url:"key,omitempty" json:"key,omitempty"`
	Value        *string            `url:"value,omitempty" json:"value,omitempty"`
	Description  *string            `url:"description,omitempty" json:"description,omitempty"`
	Masked       *bool              `url:"masked,omitempty" json:"masked,omitempty"`
	Protected    *bool              `url:"protected,omitempty" json:"protected,omitempty"`
	Raw          *bool              `url:"raw,omitempty" json:"raw,omitempty"`
	VariableType *VariableTypeValue `url:"variable_type,omitempty" json:"variable_type,omitempty"`
}

CreateInstanceVariableOptions represents the available CreateVariable() options.

GitLab API docs: https://docs.gitlab.com/api/instance_level_ci_variables/#create-instance-variable

type CreateIssueBoardListOptions added in v0.8.0 

type CreateIssueBoardListOptions struct {
	LabelID     *int64 `url:"label_id,omitempty" json:"label_id,omitempty"`
	AssigneeID  *int64 `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	MilestoneID *int64 `url:"milestone_id,omitempty" json:"milestone_id,omitempty"`
	IterationID *int64 `url:"iteration_id,omitempty" json:"iteration_id,omitempty"`
}

CreateIssueBoardListOptions represents the available CreateIssueBoardList() options.

GitLab API docs: https://docs.gitlab.com/api/boards/#create-a-board-list

type CreateIssueBoardOptions added in v0.116.0 

type CreateIssueBoardOptions struct {
	Name *string `url:"name,omitempty" json:"name,omitempty"`
}

CreateIssueBoardOptions represents the available CreateIssueBoard() options.

GitLab API docs: https://docs.gitlab.com/api/boards/#create-an-issue-board

type CreateIssueDiscussionOptions added in v0.11.2 

type CreateIssueDiscussionOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
}

CreateIssueDiscussionOptions represents the available CreateIssueDiscussion() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#create-new-issue-thread

type CreateIssueLinkOptions added in v0.8.0 

type CreateIssueLinkOptions struct {
	TargetProjectID *string `json:"target_project_id"`
	TargetIssueIID  *string `json:"target_issue_iid"`
	LinkType        *string `json:"link_type"`
}

CreateIssueLinkOptions represents the available CreateIssueLink() options.

GitLab API docs: https://docs.gitlab.com/api/issue_links/#create-an-issue-link

type CreateIssueNoteOptions 

type CreateIssueNoteOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
	Internal  *bool      `url:"internal,omitempty" json:"internal,omitempty"`
}

CreateIssueNoteOptions represents the available CreateIssueNote() options.

GitLab API docs: https://docs.gitlab.com/api/notes/#create-new-issue-note

type CreateIssueOptions 

type CreateIssueOptions struct {
	IID          *int64  `url:"iid,omitempty" json:"iid,omitempty"`
	Title        *string `url:"title,omitempty" json:"title,omitempty"`
	Description  *string `url:"description,omitempty" json:"description,omitempty"`
	Confidential *bool   `url:"confidential,omitempty" json:"confidential,omitempty"`
	// AssigneeID is a CE-only attribute. For EE, use AssigneeIDs instead.
	AssigneeID *int64 `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	// AssigneeIDs is a EE-only attribute. For CE, use AssigneeID instead.
	AssigneeIDs                        *[]int64      `url:"assignee_ids,omitempty" json:"assignee_ids,omitempty"`
	MilestoneID                        *int64        `url:"milestone_id,omitempty" json:"milestone_id,omitempty"`
	Labels                             *LabelOptions `url:"labels,comma,omitempty" json:"labels,omitempty"`
	CreatedAt                          *time.Time    `url:"created_at,omitempty" json:"created_at,omitempty"`
	DueDate                            *ISOTime      `url:"due_date,omitempty" json:"due_date,omitempty"`
	EpicID                             *int64        `url:"epic_id,omitempty" json:"epic_id,omitempty"`
	MergeRequestToResolveDiscussionsOf *int64        `url:"merge_request_to_resolve_discussions_of,omitempty" json:"merge_request_to_resolve_discussions_of,omitempty"`
	DiscussionToResolve                *string       `url:"discussion_to_resolve,omitempty" json:"discussion_to_resolve,omitempty"`
	Weight                             *int64        `url:"weight,omitempty" json:"weight,omitempty"`
	IssueType                          *string       `url:"issue_type,omitempty" json:"issue_type,omitempty"`
}

CreateIssueOptions represents the available CreateIssue() options.

GitLab API docs: https://docs.gitlab.com/api/issues/#new-issue

type CreateLabelOptions 

type CreateLabelOptions struct {
	Name        *string `url:"name,omitempty" json:"name,omitempty"`
	Color       *string `url:"color,omitempty" json:"color,omitempty"`
	Description *string `url:"description,omitempty" json:"description,omitempty"`
	Priority    *int64  `url:"priority,omitempty" json:"priority,omitempty"`
	Archived    *bool   `url:"archived,omitempty" json:"archived,omitempty"`
}

CreateLabelOptions represents the available CreateLabel() options.

GitLab API docs: https://docs.gitlab.com/api/labels/#create-a-project-label

type CreateMemberRoleOptions added in v0.116.0 

type CreateMemberRoleOptions struct {
	Name                       *string           `url:"name,omitempty" json:"name,omitempty"`
	BaseAccessLevel            *AccessLevelValue `url:"base_access_level,omitempty" json:"base_access_level,omitempty"`
	Description                *string           `url:"description,omitempty" json:"description,omitempty"`
	AdminCICDVariables         *bool             `url:"admin_cicd_variables" json:"admin_cicd_variables,omitempty"`
	AdminComplianceFramework   *bool             `url:"admin_compliance_framework" json:"admin_compliance_framework,omitempty"`
	AdminGroupMembers          *bool             `url:"admin_group_member" json:"admin_group_member,omitempty"`
	AdminMergeRequest          *bool             `url:"admin_merge_request,omitempty" json:"admin_merge_request,omitempty"`
	AdminPushRules             *bool             `url:"admin_push_rules" json:"admin_push_rules,omitempty"`
	AdminTerraformState        *bool             `url:"admin_terraform_state" json:"admin_terraform_state,omitempty"`
	AdminVulnerability         *bool             `url:"admin_vulnerability,omitempty" json:"admin_vulnerability,omitempty"`
	AdminWebHook               *bool             `url:"admin_web_hook" json:"admin_web_hook,omitempty"`
	ArchiveProject             *bool             `url:"archive_project" json:"archive_project,omitempty"`
	ManageDeployTokens         *bool             `url:"manage_deploy_tokens" json:"manage_deploy_tokens,omitempty"`
	ManageGroupAccessTokens    *bool             `url:"manage_group_access_tokens" json:"manage_group_access_tokens,omitempty"`
	ManageMergeRequestSettings *bool             `url:"manage_merge_request_settings" json:"manage_merge_request_settings,omitempty"`
	ManageProjectAccessTokens  *bool             `url:"manage_project_access_tokens" json:"manage_project_access_tokens,omitempty"`
	ManageSecurityPolicyLink   *bool             `url:"manage_security_policy_link" json:"manage_security_policy_link,omitempty"`
	ReadCode                   *bool             `url:"read_code,omitempty" json:"read_code,omitempty"`
	ReadRunners                *bool             `url:"read_runners" json:"read_runners,omitempty"`
	ReadDependency             *bool             `url:"read_dependency,omitempty" json:"read_dependency,omitempty"`
	ReadVulnerability          *bool             `url:"read_vulnerability,omitempty" json:"read_vulnerability,omitempty"`
	RemoveGroup                *bool             `url:"remove_group" json:"remove_group,omitempty"`
	RemoveProject              *bool             `url:"remove_project" json:"remove_project,omitempty"`
}

CreateMemberRoleOptions represents the available CreateInstanceMemberRole() and CreateMemberRole() options.

GitLab API docs: https://docs.gitlab.com/api/member_roles/#create-a-instance-member-role https://docs.gitlab.com/api/member_roles/#add-a-member-role-to-a-group

type CreateMergeRequestApprovalRuleOptions added in v0.116.0 

type CreateMergeRequestApprovalRuleOptions struct {
	Name                  *string  `url:"name,omitempty" json:"name,omitempty"`
	ApprovalsRequired     *int64   `url:"approvals_required,omitempty" json:"approvals_required,omitempty"`
	ApprovalProjectRuleID *int64   `url:"approval_project_rule_id,omitempty" json:"approval_project_rule_id,omitempty"`
	UserIDs               *[]int64 `url:"user_ids,omitempty" json:"user_ids,omitempty"`
	GroupIDs              *[]int64 `url:"group_ids,omitempty" json:"group_ids,omitempty"`
}

CreateMergeRequestApprovalRuleOptions represents the available CreateApprovalRule() options.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#create-merge-request-rule

type CreateMergeRequestContextCommitsOptions added in v0.157.0 

type CreateMergeRequestContextCommitsOptions struct {
	Commits *[]string `url:"commits,omitempty" json:"commits,omitempty"`
}

CreateMergeRequestContextCommitsOptions represents the available CreateMergeRequestContextCommits() options.

GitLab API docs: https://docs.gitlab.com/api/merge_request_context_commits/#create-mr-context-commits

type CreateMergeRequestDependencyOptions added in v0.119.0 

type CreateMergeRequestDependencyOptions struct {
	BlockingMergeRequestID *int64 `url:"blocking_merge_request_id,omitempty" json:"blocking_merge_request_id,omitempty"`
}

CreateMergeRequestDependencyOptions represents the available CreateMergeRequestDependency() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#create-a-merge-request-dependency

type CreateMergeRequestDiscussionOptions added in v0.11.2 

type CreateMergeRequestDiscussionOptions struct {
	Body      *string          `url:"body,omitempty" json:"body,omitempty"`
	CommitID  *string          `url:"commit_id,omitempty" json:"commit_id,omitempty"`
	CreatedAt *time.Time       `url:"created_at,omitempty" json:"created_at,omitempty"`
	Position  *PositionOptions `url:"position,omitempty" json:"position,omitempty"`
}

CreateMergeRequestDiscussionOptions represents the available CreateMergeRequestDiscussion() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#create-new-merge-request-thread

type CreateMergeRequestNoteOptions 

type CreateMergeRequestNoteOptions struct {
	Body                    *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt               *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
	Internal                *bool      `url:"internal,omitempty" json:"internal,omitempty"`
	MergeRequestDiffHeadSHA *string    `url:"merge_request_diff_head_sha,omitempty" json:"merge_request_diff_head_sha,omitempty"`
}

CreateMergeRequestNoteOptions represents the available CreateMergeRequestNote() options.

GitLab API docs: https://docs.gitlab.com/api/notes/#create-new-merge-request-note

type CreateMergeRequestOptions 

type CreateMergeRequestOptions struct {
	Title              *string       `url:"title,omitempty" json:"title,omitempty"`
	Description        *string       `url:"description,omitempty" json:"description,omitempty"`
	SourceBranch       *string       `url:"source_branch,omitempty" json:"source_branch,omitempty"`
	TargetBranch       *string       `url:"target_branch,omitempty" json:"target_branch,omitempty"`
	Labels             *LabelOptions `url:"labels,comma,omitempty" json:"labels,omitempty"`
	AssigneeID         *int64        `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	AssigneeIDs        *[]int64      `url:"assignee_ids,omitempty" json:"assignee_ids,omitempty"`
	ReviewerIDs        *[]int64      `url:"reviewer_ids,omitempty" json:"reviewer_ids,omitempty"`
	TargetProjectID    *int64        `url:"target_project_id,omitempty" json:"target_project_id,omitempty"`
	MilestoneID        *int64        `url:"milestone_id,omitempty" json:"milestone_id,omitempty"`
	RemoveSourceBranch *bool         `url:"remove_source_branch,omitempty" json:"remove_source_branch,omitempty"`
	Squash             *bool         `url:"squash,omitempty" json:"squash,omitempty"`
	AllowCollaboration *bool         `url:"allow_collaboration,omitempty" json:"allow_collaboration,omitempty"`

	// Deprecated: will be removed in v5 of the API, use the Merge Request Approvals API instead
	ApprovalsBeforeMerge *int64 `url:"approvals_before_merge,omitempty" json:"approvals_before_merge,omitempty"`
}

CreateMergeRequestOptions represents the available CreateMergeRequest() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#create-mr

type CreateMilestoneOptions 

type CreateMilestoneOptions struct {
	Title       *string  `url:"title,omitempty" json:"title,omitempty"`
	Description *string  `url:"description,omitempty" json:"description,omitempty"`
	StartDate   *ISOTime `url:"start_date,omitempty" json:"start_date,omitempty"`
	DueDate     *ISOTime `url:"due_date,omitempty" json:"due_date,omitempty"`
}

CreateMilestoneOptions represents the available CreateMilestone() options.

GitLab API docs: https://docs.gitlab.com/api/milestones/#create-new-milestone

type CreatePackageProtectionRulesOptions added in v0.154.0 

type CreatePackageProtectionRulesOptions struct {
	PackageNamePattern          *string `url:"package_name_pattern" json:"package_name_pattern"`
	PackageType                 *string `url:"package_type" json:"package_type"`
	MinimumAccessLevelForDelete *int64  `url:"minimum_access_level_for_delete" json:"minimum_access_level_for_delete"`
	MinimumAccessLevelForPush   *int64  `url:"minimum_access_level_for_push" json:"minimum_access_level_for_push"`
}

CreatePackageProtectionRulesOptions represents the available CreatePackageProtectionRules() options.

GitLab API docs: https://docs.gitlab.com/api/project_packages_protection_rules/#create-a-package-protection-rule

type CreatePagesDomainOptions added in v0.8.0 

type CreatePagesDomainOptions struct {
	Domain         *string `url:"domain,omitempty" json:"domain,omitempty"`
	AutoSslEnabled *bool   `url:"auto_ssl_enabled,omitempty" json:"auto_ssl_enabled,omitempty"`
	Certificate    *string `url:"certificate,omitempty" json:"certificate,omitempty"`
	Key            *string `url:"key,omitempty" json:"key,omitempty"`
}

CreatePagesDomainOptions represents the available CreatePagesDomain() options.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/#create-new-pages-domain

type CreatePersonalAccessTokenForCurrentUserOptions added in v0.116.0 

type CreatePersonalAccessTokenForCurrentUserOptions struct {
	Name        *string   `url:"name,omitempty" json:"name,omitempty"`
	Description *string   `url:"description,omitempty" json:"description,omitempty"`
	Scopes      *[]string `url:"scopes,omitempty" json:"scopes,omitempty"`
	ExpiresAt   *ISOTime  `url:"expires_at,omitempty" json:"expires_at,omitempty"`
}

CreatePersonalAccessTokenForCurrentUserOptions represents the available CreatePersonalAccessTokenForCurrentUser() options.

GitLab API docs: https://docs.gitlab.com/api/user_tokens/#create-a-personal-access-token

type CreatePersonalAccessTokenOptions added in v0.116.0 

type CreatePersonalAccessTokenOptions struct {
	Name        *string   `url:"name,omitempty" json:"name,omitempty"`
	Description *string   `url:"description,omitempty" json:"description,omitempty"`
	ExpiresAt   *ISOTime  `url:"expires_at,omitempty" json:"expires_at,omitempty"`
	Scopes      *[]string `url:"scopes,omitempty" json:"scopes,omitempty"`
}

CreatePersonalAccessTokenOptions represents the available CreatePersonalAccessToken() options.

GitLab API docs: https://docs.gitlab.com/api/user_tokens/#create-a-personal-access-token-for-a-user

type CreatePipelineOptions added in v0.4.0 

type CreatePipelineOptions struct {
	Ref       *string                     `url:"ref" json:"ref"`
	Variables *[]*PipelineVariableOptions `url:"variables,omitempty" json:"variables,omitempty"`

	// Inputs contains pipeline input parameters.
	// See PipelineInputsOption for supported types and usage.
	Inputs PipelineInputsOption `url:"inputs,omitempty" json:"inputs,omitempty"`
}

CreatePipelineOptions represents the available CreatePipeline() options.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#create-a-new-pipeline

type CreatePipelineScheduleOptions added in v0.9.0 

type CreatePipelineScheduleOptions struct {
	Description  *string          `url:"description" json:"description"`
	Ref          *string          `url:"ref" json:"ref"`
	Cron         *string          `url:"cron" json:"cron"`
	CronTimezone *string          `url:"cron_timezone,omitempty" json:"cron_timezone,omitempty"`
	Active       *bool            `url:"active,omitempty" json:"active,omitempty"`
	Inputs       []*PipelineInput `url:"inputs,omitempty" json:"inputs,omitempty"`
}

CreatePipelineScheduleOptions represents the available CreatePipelineSchedule() options.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#create-a-new-pipeline-schedule

type CreatePipelineScheduleVariableOptions added in v0.9.0 

type CreatePipelineScheduleVariableOptions struct {
	Key          *string            `url:"key" json:"key"`
	Value        *string            `url:"value" json:"value"`
	VariableType *VariableTypeValue `url:"variable_type,omitempty" json:"variable_type,omitempty"`
}

CreatePipelineScheduleVariableOptions represents the available CreatePipelineScheduleVariable() options.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#create-a-new-pipeline-schedule

type CreateProjectAccessTokenOptions added in v0.116.0 

type CreateProjectAccessTokenOptions struct {
	Name        *string           `url:"name,omitempty" json:"name,omitempty"`
	Description *string           `url:"description,omitempty" json:"description,omitempty"`
	Scopes      *[]string         `url:"scopes,omitempty" json:"scopes,omitempty"`
	AccessLevel *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	ExpiresAt   *ISOTime          `url:"expires_at,omitempty" json:"expires_at,omitempty"`
}

CreateProjectAccessTokenOptions represents the available CreateVariable() options.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/#create-a-project-access-token

type CreateProjectAliasOptions added in v0.150.0 

type CreateProjectAliasOptions struct {
	Name      *string `json:"name" url:"name,omitempty"`
	ProjectID int64   `json:"project_id" url:"project_id,omitempty"`
}

CreateProjectAliasOptions represents the options for creating a project alias.

GitLab API docs: https://docs.gitlab.com/api/project_aliases/#create-a-project-alias

type CreateProjectDeployTokenOptions added in v0.116.0 

type CreateProjectDeployTokenOptions struct {
	Name      *string    `url:"name,omitempty" json:"name,omitempty"`
	ExpiresAt *time.Time `url:"expires_at,omitempty" json:"expires_at,omitempty"`
	Username  *string    `url:"username,omitempty" json:"username,omitempty"`
	Scopes    *[]string  `url:"scopes,omitempty" json:"scopes,omitempty"`
}

CreateProjectDeployTokenOptions represents the available CreateProjectDeployToken() options.

GitLab API docs: https://docs.gitlab.com/api/deploy_tokens/#create-a-project-deploy-token

type CreateProjectDeploymentOptions added in v0.116.0 

type CreateProjectDeploymentOptions struct {
	Environment *string                `url:"environment,omitempty" json:"environment,omitempty"`
	Ref         *string                `url:"ref,omitempty" json:"ref,omitempty"`
	SHA         *string                `url:"sha,omitempty" json:"sha,omitempty"`
	Tag         *bool                  `url:"tag,omitempty" json:"tag,omitempty"`
	Status      *DeploymentStatusValue `url:"status,omitempty" json:"status,omitempty"`
}

CreateProjectDeploymentOptions represents the available CreateProjectDeployment() options.

GitLab API docs: https://docs.gitlab.com/api/deployments/#create-a-deployment

type CreateProjectExternalStatusCheckOptions added in v0.138.0 

type CreateProjectExternalStatusCheckOptions struct {
	Name               *string  `url:"name,omitempty" json:"name,omitempty"`
	ExternalURL        *string  `url:"external_url,omitempty" json:"external_url,omitempty"`
	SharedSecret       *string  `url:"shared_secret,omitempty" json:"shared_secret,omitempty"`
	ProtectedBranchIDs *[]int64 `url:"protected_branch_ids,omitempty" json:"protected_branch_ids,omitempty"`
}

CreateProjectExternalStatusCheckOptions represents the available CreateProjectExternalStatusCheck() options.

GitLab API docs: https://docs.gitlab.com/api/status_checks/#create-external-status-check-service

type CreateProjectFeatureFlagOptions added in v0.116.0 

type CreateProjectFeatureFlagOptions struct {
	Name        *string                        `url:"name,omitempty" json:"name,omitempty"`
	Description *string                        `url:"description,omitempty" json:"description,omitempty"`
	Version     *string                        `url:"version,omitempty" json:"version,omitempty"`
	Active      *bool                          `url:"active,omitempty" json:"active,omitempty"`
	Strategies  *[]*FeatureFlagStrategyOptions `url:"strategies,omitempty" json:"strategies,omitempty"`
}

CreateProjectFeatureFlagOptions represents the available CreateProjectFeatureFlag() options.

GitLab API docs: https://docs.gitlab.com/api/feature_flags/#create-a-feature-flag

type CreateProjectForUserOptions 

type CreateProjectForUserOptions CreateProjectOptions

CreateProjectForUserOptions represents the available CreateProjectForUser() options.

GitLab API docs: https://docs.gitlab.com/api/projects/#create-a-project-for-a-user

type CreateProjectLevelRuleOptions added in v0.116.0 

type CreateProjectLevelRuleOptions struct {
	Name                          *string   `url:"name,omitempty" json:"name,omitempty"`
	ApprovalsRequired             *int64    `url:"approvals_required,omitempty" json:"approvals_required,omitempty"`
	ReportType                    *string   `url:"report_type,omitempty" json:"report_type,omitempty"`
	RuleType                      *string   `url:"rule_type,omitempty" json:"rule_type,omitempty"`
	UserIDs                       *[]int64  `url:"user_ids,omitempty" json:"user_ids,omitempty"`
	GroupIDs                      *[]int64  `url:"group_ids,omitempty" json:"group_ids,omitempty"`
	ProtectedBranchIDs            *[]int64  `url:"protected_branch_ids,omitempty" json:"protected_branch_ids,omitempty"`
	AppliesToAllProtectedBranches *bool     `url:"applies_to_all_protected_branches,omitempty" json:"applies_to_all_protected_branches,omitempty"`
	Usernames                     *[]string `url:"usernames,omitempty" json:"usernames,omitempty"`
}

CreateProjectLevelRuleOptions represents the available CreateProjectApprovalRule() options.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#create-project-approval-rule

type CreateProjectOptions 

type CreateProjectOptions struct {
	AllowMergeOnSkippedPipeline               *bool                                `url:"allow_merge_on_skipped_pipeline,omitempty" json:"allow_merge_on_skipped_pipeline,omitempty"`
	OnlyAllowMergeIfAllStatusChecksPassed     *bool                                `url:"only_allow_merge_if_all_status_checks_passed,omitempty" json:"only_allow_merge_if_all_status_checks_passed,omitempty"`
	AnalyticsAccessLevel                      *AccessControlValue                  `url:"analytics_access_level,omitempty" json:"analytics_access_level,omitempty"`
	AutoCancelPendingPipelines                *string                              `url:"auto_cancel_pending_pipelines,omitempty" json:"auto_cancel_pending_pipelines,omitempty"`
	AutoDevopsDeployStrategy                  *string                              `url:"auto_devops_deploy_strategy,omitempty" json:"auto_devops_deploy_strategy,omitempty"`
	AutoDevopsEnabled                         *bool                                `url:"auto_devops_enabled,omitempty" json:"auto_devops_enabled,omitempty"`
	AutocloseReferencedIssues                 *bool                                `url:"autoclose_referenced_issues,omitempty" json:"autoclose_referenced_issues,omitempty"`
	Avatar                                    *ProjectAvatar                       `url:"-" json:"-"`
	BuildCoverageRegex                        *string                              `url:"build_coverage_regex,omitempty" json:"build_coverage_regex,omitempty"`
	BuildGitStrategy                          *string                              `url:"build_git_strategy,omitempty" json:"build_git_strategy,omitempty"`
	BuildTimeout                              *int64                               `url:"build_timeout,omitempty" json:"build_timeout,omitempty"`
	BuildsAccessLevel                         *AccessControlValue                  `url:"builds_access_level,omitempty" json:"builds_access_level,omitempty"`
	CIConfigPath                              *string                              `url:"ci_config_path,omitempty" json:"ci_config_path,omitempty"`
	ContainerExpirationPolicyAttributes       *ContainerExpirationPolicyAttributes `url:"container_expiration_policy_attributes,omitempty" json:"container_expiration_policy_attributes,omitempty"`
	ContainerRegistryAccessLevel              *AccessControlValue                  `url:"container_registry_access_level,omitempty" json:"container_registry_access_level,omitempty"`
	DefaultBranch                             *string                              `url:"default_branch,omitempty" json:"default_branch,omitempty"`
	Description                               *string                              `url:"description,omitempty" json:"description,omitempty"`
	EmailsEnabled                             *bool                                `url:"emails_enabled,omitempty" json:"emails_enabled,omitempty"`
	EnforceAuthChecksOnUploads                *bool                                `url:"enforce_auth_checks_on_uploads,omitempty" json:"enforce_auth_checks_on_uploads,omitempty"`
	ExternalAuthorizationClassificationLabel  *string                              `url:"external_authorization_classification_label,omitempty" json:"external_authorization_classification_label,omitempty"`
	ForkingAccessLevel                        *AccessControlValue                  `url:"forking_access_level,omitempty" json:"forking_access_level,omitempty"`
	GroupWithProjectTemplatesID               *int64                               `url:"group_with_project_templates_id,omitempty" json:"group_with_project_templates_id,omitempty"`
	ImportURL                                 *string                              `url:"import_url,omitempty" json:"import_url,omitempty"`
	InitializeWithReadme                      *bool                                `url:"initialize_with_readme,omitempty" json:"initialize_with_readme,omitempty"`
	IssuesAccessLevel                         *AccessControlValue                  `url:"issues_access_level,omitempty" json:"issues_access_level,omitempty"`
	IssueBranchTemplate                       *string                              `url:"issue_branch_template,omitempty" json:"issue_branch_template,omitempty"`
	LFSEnabled                                *bool                                `url:"lfs_enabled,omitempty" json:"lfs_enabled,omitempty"`
	MergeCommitTemplate                       *string                              `url:"merge_commit_template,omitempty" json:"merge_commit_template,omitempty"`
	MergeMethod                               *MergeMethodValue                    `url:"merge_method,omitempty" json:"merge_method,omitempty"`
	MergePipelinesEnabled                     *bool                                `url:"merge_pipelines_enabled,omitempty" json:"merge_pipelines_enabled,omitempty"`
	MergeRequestsAccessLevel                  *AccessControlValue                  `url:"merge_requests_access_level,omitempty" json:"merge_requests_access_level,omitempty"`
	MergeTrainsEnabled                        *bool                                `url:"merge_trains_enabled,omitempty" json:"merge_trains_enabled,omitempty"`
	MergeTrainsSkipTrainAllowed               *bool                                `url:"merge_trains_skip_train_allowed,omitempty" json:"merge_trains_skip_train_allowed,omitempty"`
	Mirror                                    *bool                                `url:"mirror,omitempty" json:"mirror,omitempty"`
	MirrorTriggerBuilds                       *bool                                `url:"mirror_trigger_builds,omitempty" json:"mirror_trigger_builds,omitempty"`
	ModelExperimentsAccessLevel               *AccessControlValue                  `url:"model_experiments_access_level,omitempty" json:"model_experiments_access_level,omitempty"`
	ModelRegistryAccessLevel                  *AccessControlValue                  `url:"model_registry_access_level,omitempty" json:"model_registry_access_level,omitempty"`
	Name                                      *string                              `url:"name,omitempty" json:"name,omitempty"`
	NamespaceID                               *int64                               `url:"namespace_id,omitempty" json:"namespace_id,omitempty"`
	OnlyAllowMergeIfAllDiscussionsAreResolved *bool                                `` /* 130-byte string literal not displayed */
	OnlyAllowMergeIfPipelineSucceeds          *bool                                `url:"only_allow_merge_if_pipeline_succeeds,omitempty" json:"only_allow_merge_if_pipeline_succeeds,omitempty"`
	OperationsAccessLevel                     *AccessControlValue                  `url:"operations_access_level,omitempty" json:"operations_access_level,omitempty"`
	PackagesEnabled                           *bool                                `url:"packages_enabled,omitempty" json:"packages_enabled,omitempty"`
	PagesAccessLevel                          *AccessControlValue                  `url:"pages_access_level,omitempty" json:"pages_access_level,omitempty"`
	Path                                      *string                              `url:"path,omitempty" json:"path,omitempty"`
	ReleasesAccessLevel                       *AccessControlValue                  `url:"releases_access_level,omitempty" json:"releases_access_level,omitempty"`
	EnvironmentsAccessLevel                   *AccessControlValue                  `url:"environments_access_level,omitempty" json:"environments_access_level,omitempty"`
	FeatureFlagsAccessLevel                   *AccessControlValue                  `url:"feature_flags_access_level,omitempty" json:"feature_flags_access_level,omitempty"`
	InfrastructureAccessLevel                 *AccessControlValue                  `url:"infrastructure_access_level,omitempty" json:"infrastructure_access_level,omitempty"`
	MonitorAccessLevel                        *AccessControlValue                  `url:"monitor_access_level,omitempty" json:"monitor_access_level,omitempty"`
	RemoveSourceBranchAfterMerge              *bool                                `url:"remove_source_branch_after_merge,omitempty" json:"remove_source_branch_after_merge,omitempty"`
	PrintingMergeRequestLinkEnabled           *bool                                `url:"printing_merge_request_link_enabled,omitempty" json:"printing_merge_request_link_enabled,omitempty"`
	RepositoryAccessLevel                     *AccessControlValue                  `url:"repository_access_level,omitempty" json:"repository_access_level,omitempty"`
	RepositoryStorage                         *string                              `url:"repository_storage,omitempty" json:"repository_storage,omitempty"`
	RequestAccessEnabled                      *bool                                `url:"request_access_enabled,omitempty" json:"request_access_enabled,omitempty"`
	RequirementsAccessLevel                   *AccessControlValue                  `url:"requirements_access_level,omitempty" json:"requirements_access_level,omitempty"`
	ResolveOutdatedDiffDiscussions            *bool                                `url:"resolve_outdated_diff_discussions,omitempty" json:"resolve_outdated_diff_discussions,omitempty"`
	SecurityAndComplianceAccessLevel          *AccessControlValue                  `url:"security_and_compliance_access_level,omitempty" json:"security_and_compliance_access_level,omitempty"`
	SharedRunnersEnabled                      *bool                                `url:"shared_runners_enabled,omitempty" json:"shared_runners_enabled,omitempty"`
	GroupRunnersEnabled                       *bool                                `url:"group_runners_enabled,omitempty" json:"group_runners_enabled,omitempty"`
	ResourceGroupDefaultProcessMode           *ResourceGroupProcessMode            `url:"resource_group_default_process_mode,omitempty" json:"resource_group_default_process_mode,omitempty"`
	ShowDefaultAwardEmojis                    *bool                                `url:"show_default_award_emojis,omitempty" json:"show_default_award_emojis,omitempty"`
	SnippetsAccessLevel                       *AccessControlValue                  `url:"snippets_access_level,omitempty" json:"snippets_access_level,omitempty"`
	SquashCommitTemplate                      *string                              `url:"squash_commit_template,omitempty" json:"squash_commit_template,omitempty"`
	SquashOption                              *SquashOptionValue                   `url:"squash_option,omitempty" json:"squash_option,omitempty"`
	SuggestionCommitMessage                   *string                              `url:"suggestion_commit_message,omitempty" json:"suggestion_commit_message,omitempty"`
	TemplateName                              *string                              `url:"template_name,omitempty" json:"template_name,omitempty"`
	TemplateProjectID                         *int64                               `url:"template_project_id,omitempty" json:"template_project_id,omitempty"`
	Topics                                    *[]string                            `url:"topics,omitempty" json:"topics,omitempty"`
	UseCustomTemplate                         *bool                                `url:"use_custom_template,omitempty" json:"use_custom_template,omitempty"`
	Visibility                                *VisibilityValue                     `url:"visibility,omitempty" json:"visibility,omitempty"`
	WikiAccessLevel                           *AccessControlValue                  `url:"wiki_access_level,omitempty" json:"wiki_access_level,omitempty"`

	// Deprecated: use Merge Request Approvals API instead
	ApprovalsBeforeMerge *int64 `url:"approvals_before_merge,omitempty" json:"approvals_before_merge,omitempty"`
	// Deprecated: use PublicJobs instead
	PublicBuilds *bool `url:"public_builds,omitempty" json:"public_builds,omitempty"`
	// Deprecated: No longer supported in recent versions.
	CIForwardDeploymentEnabled *bool `url:"ci_forward_deployment_enabled,omitempty" json:"ci_forward_deployment_enabled,omitempty"`
	// Deprecated: Use ContainerRegistryAccessLevel instead.
	ContainerRegistryEnabled *bool `url:"container_registry_enabled,omitempty" json:"container_registry_enabled,omitempty"`
	// Deprecated: Use EmailsEnabled instead
	EmailsDisabled *bool `url:"emails_disabled,omitempty" json:"emails_disabled,omitempty"`
	// Deprecated: Use IssuesAccessLevel instead.
	IssuesEnabled *bool `url:"issues_enabled,omitempty" json:"issues_enabled,omitempty"`
	// Deprecated: No longer supported in recent versions.
	IssuesTemplate *string `url:"issues_template,omitempty" json:"issues_template,omitempty"`
	// Deprecated: Use BuildsAccessLevel instead.
	JobsEnabled *bool `url:"jobs_enabled,omitempty" json:"jobs_enabled,omitempty"`
	// Deprecated: Use MergeRequestsAccessLevel instead.
	MergeRequestsEnabled *bool `url:"merge_requests_enabled,omitempty" json:"merge_requests_enabled,omitempty"`
	// Deprecated: No longer supported in recent versions.
	MergeRequestsTemplate *string `url:"merge_requests_template,omitempty" json:"merge_requests_template,omitempty"`
	// Deprecated: No longer supported in recent versions.
	ServiceDeskEnabled *bool `url:"service_desk_enabled,omitempty" json:"service_desk_enabled,omitempty"`
	// Deprecated: Use SnippetsAccessLevel instead.
	SnippetsEnabled *bool `url:"snippets_enabled,omitempty" json:"snippets_enabled,omitempty"`
	// Deprecated: Use Topics instead. (Deprecated in GitLab 14.0)
	TagList *[]string `url:"tag_list,omitempty" json:"tag_list,omitempty"`
	// Deprecated: Use WikiAccessLevel instead.
	WikiEnabled *bool `url:"wiki_enabled,omitempty" json:"wiki_enabled,omitempty"`
}

CreateProjectOptions represents the available CreateProject() options.

GitLab API docs: https://docs.gitlab.com/api/projects/#create-a-project

type CreateProjectSnippetOptions added in v0.7.2 

type CreateProjectSnippetOptions struct {
	Title       *string                      `url:"title,omitempty" json:"title,omitempty"`
	Description *string                      `url:"description,omitempty" json:"description,omitempty"`
	Visibility  *VisibilityValue             `url:"visibility,omitempty" json:"visibility,omitempty"`
	Files       *[]*CreateSnippetFileOptions `url:"files,omitempty" json:"files,omitempty"`

	// Deprecated: use Files instead
	FileName *string `url:"file_name,omitempty" json:"file_name,omitempty"`
	// Deprecated: use Files instead
	Content *string `url:"content,omitempty" json:"content,omitempty"`
}

CreateProjectSnippetOptions represents the available CreateSnippet() options.

GitLab API docs: https://docs.gitlab.com/api/project_snippets/#create-new-snippet

type CreateProjectVariableOptions added in v0.116.0 

type CreateProjectVariableOptions struct {
	Key              *string            `url:"key,omitempty" json:"key,omitempty"`
	Value            *string            `url:"value,omitempty" json:"value,omitempty"`
	Description      *string            `url:"description,omitempty" json:"description,omitempty"`
	EnvironmentScope *string            `url:"environment_scope,omitempty" json:"environment_scope,omitempty"`
	Masked           *bool              `url:"masked,omitempty" json:"masked,omitempty"`
	MaskedAndHidden  *bool              `url:"masked_and_hidden,omitempty" json:"masked_and_hidden,omitempty"`
	Protected        *bool              `url:"protected,omitempty" json:"protected,omitempty"`
	Raw              *bool              `url:"raw,omitempty" json:"raw,omitempty"`
	VariableType     *VariableTypeValue `url:"variable_type,omitempty" json:"variable_type,omitempty"`
}

CreateProjectVariableOptions represents the available CreateVariable() options.

GitLab API docs: https://docs.gitlab.com/api/project_level_variables/#create-a-variable

type CreateReleaseLinkOptions added in v0.116.0 

type CreateReleaseLinkOptions struct {
	Name            *string        `url:"name,omitempty" json:"name,omitempty"`
	URL             *string        `url:"url,omitempty" json:"url,omitempty"`
	FilePath        *string        `url:"filepath,omitempty" json:"filepath,omitempty"`
	DirectAssetPath *string        `url:"direct_asset_path,omitempty" json:"direct_asset_path,omitempty"`
	LinkType        *LinkTypeValue `url:"link_type,omitempty" json:"link_type,omitempty"`
}

CreateReleaseLinkOptions represents CreateReleaseLink() options.

GitLab API docs: https://docs.gitlab.com/api/releases/links/#create-a-release-link

type CreateReleaseOptions added in v0.10.0 

type CreateReleaseOptions struct {
	Name        *string               `url:"name,omitempty" json:"name,omitempty"`
	TagName     *string               `url:"tag_name,omitempty" json:"tag_name,omitempty"`
	TagMessage  *string               `url:"tag_message,omitempty" json:"tag_message,omitempty"`
	Description *string               `url:"description,omitempty" json:"description,omitempty"`
	Ref         *string               `url:"ref,omitempty" json:"ref,omitempty"`
	Milestones  *[]string             `url:"milestones,omitempty" json:"milestones,omitempty"`
	Assets      *ReleaseAssetsOptions `url:"assets,omitempty" json:"assets,omitempty"`
	ReleasedAt  *time.Time            `url:"released_at,omitempty" json:"released_at,omitempty"`
}

CreateReleaseOptions represents CreateRelease() options.

GitLab API docs: https://docs.gitlab.com/api/releases/#create-a-release

type CreateRunnerControllerOptions added in v1.10.0 

type CreateRunnerControllerOptions struct {
	Description *string                     `url:"description,omitempty" json:"description,omitempty"`
	State       *RunnerControllerStateValue `url:"state,omitempty" json:"state,omitempty"`
}

CreateRunnerControllerOptions represents the available CreateRunnerController() options.

GitLab API docs: https://docs.gitlab.com/api/runner_controllers/#register-a-runner-controller

type CreateRunnerControllerTokenOptions added in v1.10.0 

type CreateRunnerControllerTokenOptions struct {
	Description *string `url:"description,omitempty" json:"description,omitempty"`
}

CreateRunnerControllerTokenOptions represents the available CreateRunnerControllerToken() options.

GitLab API docs: https://docs.gitlab.com/api/runner_controller_tokens/#create-a-runner-controller-token

type CreateSecureFileOptions added in v0.127.0 

type CreateSecureFileOptions struct {
	Name *string `url:"name,omitempty" json:"name,omitempty"`
}

CreateSecureFileOptions represents the available CreateSecureFile() options.

GitLab API docs: https://docs.gitlab.com/api/secure_files/#create-secure-file

type CreateServiceAccountOptions added in v0.116.0 

type CreateServiceAccountOptions struct {
	Name     *string `url:"name,omitempty" json:"name,omitempty"`
	Username *string `url:"username,omitempty" json:"username,omitempty"`
	Email    *string `url:"email,omitempty" json:"email,omitempty"`
}

CreateServiceAccountOptions represents the available CreateServiceAccount() options.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#create-a-group-service-account

type CreateServiceAccountPersonalAccessTokenOptions added in v0.116.0 

type CreateServiceAccountPersonalAccessTokenOptions struct {
	Name        *string   `url:"name,omitempty" json:"name,omitempty"`
	Description *string   `url:"description,omitempty" json:"description,omitempty"`
	Scopes      *[]string `url:"scopes,omitempty" json:"scopes,omitempty"`
	ExpiresAt   *ISOTime  `url:"expires_at,omitempty" json:"expires_at,omitempty"`
}

CreateServiceAccountPersonalAccessTokenOptions represents the available CreateServiceAccountPersonalAccessToken() options.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#create-a-personal-access-token-for-a-group-service-account

type CreateServiceAccountUserOptions added in v0.116.0 

type CreateServiceAccountUserOptions struct {
	Name     *string `url:"name,omitempty" json:"name,omitempty"`
	Username *string `url:"username,omitempty" json:"username,omitempty"`
	Email    *string `url:"email,omitempty" json:"email,omitempty"`
}

CreateServiceAccountUserOptions represents the available CreateServiceAccountUser() options.

GitLab API docs: https://docs.gitlab.com/api/user_service_accounts/#create-a-service-account-user

type CreateSnippetDiscussionOptions added in v0.11.2 

type CreateSnippetDiscussionOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
}

CreateSnippetDiscussionOptions represents the available CreateSnippetDiscussion() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#create-new-snippet-thread

type CreateSnippetFileOptions added in v0.116.0 

type CreateSnippetFileOptions struct {
	FilePath *string `url:"file_path,omitempty" json:"file_path,omitempty"`
	Content  *string `url:"content,omitempty" json:"content,omitempty"`
}

CreateSnippetFileOptions represents the create snippet file options.

GitLab API docs: https://docs.gitlab.com/api/snippets/#create-new-snippet

type CreateSnippetNoteOptions 

type CreateSnippetNoteOptions struct {
	Body      *string    `url:"body,omitempty" json:"body,omitempty"`
	CreatedAt *time.Time `url:"created_at,omitempty" json:"created_at,omitempty"`
}

CreateSnippetNoteOptions represents the available CreateSnippetNote() options.

GitLab API docs: https://docs.gitlab.com/api/notes/#create-new-snippet-note

type CreateSnippetOptions 

type CreateSnippetOptions struct {
	Title       *string                      `url:"title,omitempty" json:"title,omitempty"`
	FileName    *string                      `url:"file_name,omitempty" json:"file_name,omitempty"`
	Description *string                      `url:"description,omitempty" json:"description,omitempty"`
	Content     *string                      `url:"content,omitempty" json:"content,omitempty"`
	Visibility  *VisibilityValue             `url:"visibility,omitempty" json:"visibility,omitempty"`
	Files       *[]*CreateSnippetFileOptions `url:"files,omitempty" json:"files,omitempty"`
}

CreateSnippetOptions represents the available CreateSnippet() options.

GitLab API docs: https://docs.gitlab.com/api/snippets/#create-new-snippet

type CreateTagOptions 

type CreateTagOptions struct {
	TagName *string `url:"tag_name,omitempty" json:"tag_name,omitempty"`
	Ref     *string `url:"ref,omitempty" json:"ref,omitempty"`
	Message *string `url:"message,omitempty" json:"message,omitempty"`
}

CreateTagOptions represents the available CreateTag() options.

GitLab API docs: https://docs.gitlab.com/api/tags/#create-a-new-tag

type CreateTopicOptions added in v0.116.0 

type CreateTopicOptions struct {
	Name        *string      `url:"name,omitempty" json:"name,omitempty"`
	Title       *string      `url:"title,omitempty" json:"title,omitempty"`
	Description *string      `url:"description,omitempty" json:"description,omitempty"`
	Avatar      *TopicAvatar `url:"-" json:"-"`
}

CreateTopicOptions represents the available CreateTopic() options.

GitLab API docs: https://docs.gitlab.com/api/topics/#create-a-project-topic

type CreateUserOptions 

type CreateUserOptions struct {
	Admin               *bool       `url:"admin,omitempty" json:"admin,omitempty"`
	Avatar              *UserAvatar `url:"-" json:"-"`
	Bio                 *string     `url:"bio,omitempty" json:"bio,omitempty"`
	CanCreateGroup      *bool       `url:"can_create_group,omitempty" json:"can_create_group,omitempty"`
	Email               *string     `url:"email,omitempty" json:"email,omitempty"`
	External            *bool       `url:"external,omitempty" json:"external,omitempty"`
	ExternUID           *string     `url:"extern_uid,omitempty" json:"extern_uid,omitempty"`
	ForceRandomPassword *bool       `url:"force_random_password,omitempty" json:"force_random_password,omitempty"`
	JobTitle            *string     `url:"job_title,omitempty" json:"job_title,omitempty"`
	Linkedin            *string     `url:"linkedin,omitempty" json:"linkedin,omitempty"`
	Location            *string     `url:"location,omitempty" json:"location,omitempty"`
	Name                *string     `url:"name,omitempty" json:"name,omitempty"`
	Note                *string     `url:"note,omitempty" json:"note,omitempty"`
	Organization        *string     `url:"organization,omitempty" json:"organization,omitempty"`
	Password            *string     `url:"password,omitempty" json:"password,omitempty"`
	PrivateProfile      *bool       `url:"private_profile,omitempty" json:"private_profile,omitempty"`
	ProjectsLimit       *int64      `url:"projects_limit,omitempty" json:"projects_limit,omitempty"`
	Provider            *string     `url:"provider,omitempty" json:"provider,omitempty"`
	ResetPassword       *bool       `url:"reset_password,omitempty" json:"reset_password,omitempty"`
	SkipConfirmation    *bool       `url:"skip_confirmation,omitempty" json:"skip_confirmation,omitempty"`
	Skype               *string     `url:"skype,omitempty" json:"skype,omitempty"`
	ThemeID             *int64      `url:"theme_id,omitempty" json:"theme_id,omitempty"`
	Twitter             *string     `url:"twitter,omitempty" json:"twitter,omitempty"`
	Username            *string     `url:"username,omitempty" json:"username,omitempty"`
	WebsiteURL          *string     `url:"website_url,omitempty" json:"website_url,omitempty"`
	ViewDiffsFileByFile *bool       `url:"view_diffs_file_by_file,omitempty" json:"view_diffs_file_by_file,omitempty"`
	PublicEmail         *string     `url:"public_email,omitempty" json:"public_email,omitempty"`
}

CreateUserOptions represents the available CreateUser() options.

GitLab API docs: https://docs.gitlab.com/api/users/#create-a-user

type CreateUserRunnerOptions added in v0.116.0 

type CreateUserRunnerOptions struct {
	RunnerType      *string   `url:"runner_type,omitempty" json:"runner_type,omitempty"`
	GroupID         *int64    `url:"group_id,omitempty" json:"group_id,omitempty"`
	ProjectID       *int64    `url:"project_id,omitempty" json:"project_id,omitempty"`
	Description     *string   `url:"description,omitempty" json:"description,omitempty"`
	Paused          *bool     `url:"paused,omitempty" json:"paused,omitempty"`
	Locked          *bool     `url:"locked,omitempty" json:"locked,omitempty"`
	RunUntagged     *bool     `url:"run_untagged,omitempty" json:"run_untagged,omitempty"`
	TagList         *[]string `url:"tag_list,omitempty" json:"tag_list,omitempty"`
	AccessLevel     *string   `url:"access_level,omitempty" json:"access_level,omitempty"`
	MaximumTimeout  *int64    `url:"maximum_timeout,omitempty" json:"maximum_timeout,omitempty"`
	MaintenanceNote *string   `url:"maintenance_note,omitempty" json:"maintenance_note,omitempty"`
}

CreateUserRunnerOptions represents the available CreateUserRunner() options.

GitLab API docs: https://docs.gitlab.com/api/users/#create-a-runner-linked-to-a-user

type CreateVulnerabilityOptions added in v0.116.0 

type CreateVulnerabilityOptions struct {
	FindingID *int64 `url:"finding_id,omitempty" json:"finding_id,omitempty"`
}

CreateVulnerabilityOptions represents the available CreateVulnerability() options. Deprecated: use GraphQL Query.vulnerabilities instead

GitLab API docs: https://docs.gitlab.com/api/project_vulnerabilities/#new-vulnerability

type CreateWikiPageOptions added in v0.7.0 

type CreateWikiPageOptions struct {
	Content *string          `url:"content,omitempty" json:"content,omitempty"`
	Title   *string          `url:"title,omitempty" json:"title,omitempty"`
	Format  *WikiFormatValue `url:"format,omitempty" json:"format,omitempty"`
}

CreateWikiPageOptions represents options to CreateWikiPage.

GitLab API docs: https://docs.gitlab.com/api/wikis/#create-a-new-wiki-page

type CustomAttribute added in v0.11.1 

type CustomAttribute struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

CustomAttribute struct is used to unmarshal response to api calls.

GitLab API docs: https://docs.gitlab.com/api/custom_attributes/

type CustomAttributesService added in v0.11.1 

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

CustomAttributesService handles communication with the group, project and user custom attributes related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/custom_attributes/

func (*CustomAttributesService) DeleteCustomGroupAttribute added in v0.11.1 

func (s *CustomAttributesService) DeleteCustomGroupAttribute(group int64, key string, options ...RequestOptionFunc) (*Response, error)

func (*CustomAttributesService) DeleteCustomProjectAttribute added in v0.11.1 

func (s *CustomAttributesService) DeleteCustomProjectAttribute(project int64, key string, options ...RequestOptionFunc) (*Response, error)

func (*CustomAttributesService) DeleteCustomUserAttribute added in v0.11.1 

func (s *CustomAttributesService) DeleteCustomUserAttribute(user int64, key string, options ...RequestOptionFunc) (*Response, error)

func (*CustomAttributesService) GetCustomGroupAttribute added in v0.11.1 

func (s *CustomAttributesService) GetCustomGroupAttribute(group int64, key string, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

func (*CustomAttributesService) GetCustomProjectAttribute added in v0.11.1 

func (s *CustomAttributesService) GetCustomProjectAttribute(project int64, key string, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

func (*CustomAttributesService) GetCustomUserAttribute added in v0.11.1 

func (s *CustomAttributesService) GetCustomUserAttribute(user int64, key string, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

func (*CustomAttributesService) ListCustomGroupAttributes added in v0.11.1 

func (s *CustomAttributesService) ListCustomGroupAttributes(group int64, options ...RequestOptionFunc) ([]*CustomAttribute, *Response, error)

func (*CustomAttributesService) ListCustomProjectAttributes added in v0.11.1 

func (s *CustomAttributesService) ListCustomProjectAttributes(project int64, options ...RequestOptionFunc) ([]*CustomAttribute, *Response, error)

func (*CustomAttributesService) ListCustomUserAttributes added in v0.11.1 

func (s *CustomAttributesService) ListCustomUserAttributes(user int64, options ...RequestOptionFunc) ([]*CustomAttribute, *Response, error)

func (*CustomAttributesService) SetCustomGroupAttribute added in v0.11.1 

func (s *CustomAttributesService) SetCustomGroupAttribute(group int64, c CustomAttribute, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

func (*CustomAttributesService) SetCustomProjectAttribute added in v0.11.1 

func (s *CustomAttributesService) SetCustomProjectAttribute(project int64, c CustomAttribute, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

func (*CustomAttributesService) SetCustomUserAttribute added in v0.11.1 

func (s *CustomAttributesService) SetCustomUserAttribute(user int64, c CustomAttribute, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

type CustomAttributesServiceInterface added in v0.126.0 

type CustomAttributesServiceInterface interface {
	// ListCustomUserAttributes lists the custom attributes of the specified user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#list-custom-attributes
	ListCustomUserAttributes(user int64, options ...RequestOptionFunc) ([]*CustomAttribute, *Response, error)

	// ListCustomGroupAttributes lists the custom attributes of the specified group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#list-custom-attributes
	ListCustomGroupAttributes(group int64, options ...RequestOptionFunc) ([]*CustomAttribute, *Response, error)

	// ListCustomProjectAttributes lists the custom attributes of the specified project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#list-custom-attributes
	ListCustomProjectAttributes(project int64, options ...RequestOptionFunc) ([]*CustomAttribute, *Response, error)

	// GetCustomUserAttribute returns the user attribute with a specific key.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#single-custom-attribute
	GetCustomUserAttribute(user int64, key string, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

	// GetCustomGroupAttribute returns the group attribute with a specific key.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#single-custom-attribute
	GetCustomGroupAttribute(group int64, key string, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

	// GetCustomProjectAttribute returns the project attribute with a specific key.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#single-custom-attribute
	GetCustomProjectAttribute(project int64, key string, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

	// SetCustomUserAttribute sets the custom attributes of the specified user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#set-custom-attribute
	SetCustomUserAttribute(user int64, c CustomAttribute, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

	// SetCustomGroupAttribute sets the custom attributes of the specified group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#set-custom-attribute
	SetCustomGroupAttribute(group int64, c CustomAttribute, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

	// SetCustomProjectAttribute sets the custom attributes of the specified project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#set-custom-attribute
	SetCustomProjectAttribute(project int64, c CustomAttribute, options ...RequestOptionFunc) (*CustomAttribute, *Response, error)

	// DeleteCustomUserAttribute removes the custom attribute of the specified user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#delete-custom-attribute
	DeleteCustomUserAttribute(user int64, key string, options ...RequestOptionFunc) (*Response, error)

	// DeleteCustomGroupAttribute removes the custom attribute of the specified group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#delete-custom-attribute
	DeleteCustomGroupAttribute(group int64, key string, options ...RequestOptionFunc) (*Response, error)

	// DeleteCustomProjectAttribute removes the custom attribute of the specified project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/custom_attributes/#delete-custom-attribute
	DeleteCustomProjectAttribute(project int64, key string, options ...RequestOptionFunc) (*Response, error)
}

type CustomIssueTrackerService added in v0.116.0 

type CustomIssueTrackerService struct {
	Service
	Properties *CustomIssueTrackerServiceProperties `json:"properties"`
}

CustomIssueTrackerService represents Custom Issue Tracker service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#custom-issue-tracker

type CustomIssueTrackerServiceProperties added in v0.116.0 

type CustomIssueTrackerServiceProperties struct {
	ProjectURL  string `json:"project_url,omitempty"`
	IssuesURL   string `json:"issues_url,omitempty"`
	NewIssueURL string `json:"new_issue_url,omitempty"`
}

CustomIssueTrackerServiceProperties represents Custom Issue Tracker specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#custom-issue-tracker

type DORAMetric added in v0.116.0 

type DORAMetric struct {
	Date  string  `json:"date"`
	Value float64 `json:"value"`
}

DORAMetric represents a single DORA metric data point.

GitLab API docs: https://docs.gitlab.com/api/dora/metrics/

func (DORAMetric) String added in v0.116.0 

func (m DORAMetric) String() string

String gets a string representation of a DORAMetric data point

GitLab API docs: https://docs.gitlab.com/api/dora/metrics/

type DORAMetricInterval added in v0.116.0 

type DORAMetricInterval string

DORAMetricInterval represents the time period over which the metrics are aggregated.

GitLab API docs: https://docs.gitlab.com/api/dora/metrics/ 

const (
	DORAMetricIntervalDaily   DORAMetricInterval = "daily"
	DORAMetricIntervalMonthly DORAMetricInterval = "monthly"
	DORAMetricIntervalAll     DORAMetricInterval = "all"
)

List of available DORA metric interval types.

GitLab API docs: https://docs.gitlab.com/api/dora/metrics/

type DORAMetricType added in v0.116.0 

type DORAMetricType string

DORAMetricType represents all valid DORA metrics types.

GitLab API docs: https://docs.gitlab.com/api/dora/metrics/ 

const (
	DORAMetricDeploymentFrequency  DORAMetricType = "deployment_frequency"
	DORAMetricLeadTimeForChanges   DORAMetricType = "lead_time_for_changes"
	DORAMetricTimeToRestoreService DORAMetricType = "time_to_restore_service"
	DORAMetricChangeFailureRate    DORAMetricType = "change_failure_rate"
)

List of available DORA metric type names.

GitLab API docs: https://docs.gitlab.com/api/dora/metrics/

type DORAMetricsService added in v0.116.0 

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

DORAMetricsService handles communication with the DORA metrics related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/dora/metrics/

func (*DORAMetricsService) GetGroupDORAMetrics added in v0.116.0 

func (s *DORAMetricsService) GetGroupDORAMetrics(gid any, opt GetDORAMetricsOptions, options ...RequestOptionFunc) ([]DORAMetric, *Response, error)

func (*DORAMetricsService) GetProjectDORAMetrics added in v0.116.0 

func (s *DORAMetricsService) GetProjectDORAMetrics(pid any, opt GetDORAMetricsOptions, options ...RequestOptionFunc) ([]DORAMetric, *Response, error)

type DORAMetricsServiceInterface added in v0.126.0 

type DORAMetricsServiceInterface interface {
	// GetProjectDORAMetrics gets the DORA metrics for a project.
	//
	// GitLab API Docs:
	// https://docs.gitlab.com/api/dora/metrics/#get-project-level-dora-metrics
	GetProjectDORAMetrics(pid any, opt GetDORAMetricsOptions, options ...RequestOptionFunc) ([]DORAMetric, *Response, error)

	// GetGroupDORAMetrics gets the DORA metrics for a group.
	//
	// GitLab API Docs:
	// https://docs.gitlab.com/api/dora/metrics/#get-group-level-dora-metrics
	GetGroupDORAMetrics(gid any, opt GetDORAMetricsOptions, options ...RequestOptionFunc) ([]DORAMetric, *Response, error)
}

DORAMetricsServiceInterface defines all the API methods for the DORAMetricsService

type DataDogService added in v0.116.0 

type DataDogService struct {
	Service
	Properties *DataDogServiceProperties `json:"properties"`
}

DataDogService represents DataDog service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#datadog

type DataDogServiceProperties added in v0.116.0 

type DataDogServiceProperties struct {
	APIURL               string `url:"api_url,omitempty" json:"api_url,omitempty"`
	DataDogEnv           string `url:"datadog_env,omitempty" json:"datadog_env,omitempty"`
	DataDogService       string `url:"datadog_service,omitempty" json:"datadog_service,omitempty"`
	DataDogSite          string `url:"datadog_site,omitempty" json:"datadog_site,omitempty"`
	DataDogTags          string `url:"datadog_tags,omitempty" json:"datadog_tags,omitempty"`
	ArchiveTraceEvents   bool   `url:"archive_trace_events,omitempty" json:"archive_trace_events,omitempty"`
	DataDogCIVisibility  bool   `url:"datadog_ci_visibility,omitempty" json:"datadog_ci_visibility,omitempty"`
	UseInheritedSettings bool   `url:"use_inherited_settings,omitempty" json:"use_inherited_settings,omitempty"`
}

DataDogServiceProperties represents DataDog specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#datadog

type DatabaseMigrationsService added in v0.128.0 

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

DatabaseMigrationsService handles communication with the database migrations related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/database_migrations/

func (*DatabaseMigrationsService) MarkMigrationAsSuccessful added in v0.128.0 

func (s *DatabaseMigrationsService) MarkMigrationAsSuccessful(version int64, opt *MarkMigrationAsSuccessfulOptions, options ...RequestOptionFunc) (*Response, error)

type DatabaseMigrationsServiceInterface added in v0.128.0 

type DatabaseMigrationsServiceInterface interface {
	// MarkMigrationAsSuccessful marks pending migrations as successfully executed
	// to prevent them from being executed by the db:migrate tasks. Use this API to
	// skip failing migrations after they are determined to be safe to skip.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/database_migrations/#mark-a-migration-as-successful
	MarkMigrationAsSuccessful(version int64, opt *MarkMigrationAsSuccessfulOptions, options ...RequestOptionFunc) (*Response, error)
}

type DayStats added in v0.153.0 

type DayStats struct {
	Count int64  `json:"count"`
	Date  string `json:"date"`
}

type DefaultBranchProtectionDefaultsOptions added in v0.116.0 

type DefaultBranchProtectionDefaultsOptions struct {
	AllowedToPush             *[]*GroupAccessLevel `url:"allowed_to_push,omitempty" json:"allowed_to_push,omitempty"`
	AllowForcePush            *bool                `url:"allow_force_push,omitempty" json:"allow_force_push,omitempty"`
	AllowedToMerge            *[]*GroupAccessLevel `url:"allowed_to_merge,omitempty" json:"allowed_to_merge,omitempty"`
	DeveloperCanInitialPush   *bool                `url:"developer_can_initial_push,omitempty" json:"developer_can_initial_push,omitempty"`
	CodeOwnerApprovalRequired *bool                `url:"code_owner_approval_required,omitempty" json:"code_owner_approval_required,omitempty"`
}

DefaultBranchProtectionDefaultsOptions represents the available options for using default_branch_protection_defaults in CreateGroup() or UpdateGroup()

GitLab API docs: https://docs.gitlab.com/api/groups/#options-for-default_branch_protection_defaults

func (*DefaultBranchProtectionDefaultsOptions) EncodeValues added in v0.130.0 

func (d *DefaultBranchProtectionDefaultsOptions) EncodeValues(key string, v *url.Values) error

EncodeValues implements the query.Encoder interface

type DeleteEnterpriseUserOptions added in v0.151.0 

type DeleteEnterpriseUserOptions struct {
	HardDelete *bool `url:"hard_delete,omitempty" json:"hard_delete,omitempty"`
}

DeleteEnterpriseUserOptions represents the available DeleteEnterpriseUser options.

GitLab API docs: https://docs.gitlab.com/api/group_enterprise_users/#delete-an-enterprise-user

type DeleteFileOptions 

type DeleteFileOptions struct {
	Branch        *string `url:"branch,omitempty" json:"branch,omitempty"`
	StartBranch   *string `url:"start_branch,omitempty" json:"start_branch,omitempty"`
	AuthorEmail   *string `url:"author_email,omitempty" json:"author_email,omitempty"`
	AuthorName    *string `url:"author_name,omitempty" json:"author_name,omitempty"`
	CommitMessage *string `url:"commit_message,omitempty" json:"commit_message,omitempty"`
	LastCommitID  *string `url:"last_commit_id,omitempty" json:"last_commit_id,omitempty"`
}

DeleteFileOptions represents the available DeleteFile() options.

GitLab API docs: https://docs.gitlab.com/api/repository_files/#delete-existing-file-in-repository

type DeleteGroupLDAPLinkWithCNOrFilterOptions added in v0.116.0 

type DeleteGroupLDAPLinkWithCNOrFilterOptions struct {
	CN       *string `url:"cn,omitempty" json:"cn,omitempty"`
	Filter   *string `url:"filter,omitempty" json:"filter,omitempty"`
	Provider *string `url:"provider,omitempty" json:"provider,omitempty"`
}

DeleteGroupLDAPLinkWithCNOrFilterOptions represents the available DeleteGroupLDAPLinkWithCNOrFilter() options.

GitLab API docs: https://docs.gitlab.com/api/group_ldap_links/#delete-an-ldap-group-link-with-cn-or-filter

type DeleteGroupLabelOptions added in v0.116.0 

type DeleteGroupLabelOptions struct {
	Name *string `url:"name,omitempty" json:"name,omitempty"`
}

DeleteGroupLabelOptions represents the available DeleteGroupLabel() options.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#delete-a-group-label

type DeleteGroupOptions added in v0.116.0 

type DeleteGroupOptions struct {
	PermanentlyRemove *bool   `url:"permanently_remove,omitempty" json:"permanently_remove,omitempty"`
	FullPath          *string `url:"full_path,omitempty" json:"full_path,omitempty"`
}

DeleteGroupOptions represents the available DeleteGroup() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#delete-a-group

type DeleteLabelOptions 

type DeleteLabelOptions struct {
	Name *string `url:"name,omitempty" json:"name,omitempty"`
}

DeleteLabelOptions represents the available DeleteLabel() options.

GitLab API docs: https://docs.gitlab.com/api/labels/#delete-a-label

type DeleteMergeRequestContextCommitsOptions added in v0.157.0 

type DeleteMergeRequestContextCommitsOptions struct {
	Commits *[]string `url:"commits,omitempty" json:"commits,omitempty"`
}

DeleteMergeRequestContextCommitsOptions represents the available DeleteMergeRequestContextCommits() options.

GitLab API docs: https://docs.gitlab.com/api/merge_request_context_commits/#delete-mr-context-commits

type DeleteProjectExternalStatusCheckOptions added in v0.138.0 

type DeleteProjectExternalStatusCheckOptions struct{}

DeleteProjectExternalStatusCheckOptions represents the available DeleteProjectExternalStatusCheck() options.

GitLab API docs: https://docs.gitlab.com/api/status_checks/#delete-external-status-check-service

type DeleteProjectOptions added in v0.116.0 

type DeleteProjectOptions struct {
	FullPath          *string `url:"full_path" json:"full_path"`
	PermanentlyRemove *bool   `url:"permanently_remove" json:"permanently_remove"`
}

DeleteProjectOptions represents the available DeleteProject() options.

GitLab API docs: https://docs.gitlab.com/api/projects/#delete-a-project

type DeleteRegisteredRunnerOptions added in v0.11.0 

type DeleteRegisteredRunnerOptions struct {
	Token *string `url:"token" json:"token"`
}

DeleteRegisteredRunnerOptions represents the available DeleteRegisteredRunner() options.

GitLab API docs: https://docs.gitlab.com/api/runners/#delete-a-runner-by-authentication-token

type DeleteRegistryRepositoryTagsOptions added in v0.116.0 

type DeleteRegistryRepositoryTagsOptions struct {
	NameRegexpDelete *string `url:"name_regex_delete,omitempty" json:"name_regex_delete,omitempty"`
	NameRegexpKeep   *string `url:"name_regex_keep,omitempty" json:"name_regex_keep,omitempty"`
	KeepN            *int64  `url:"keep_n,omitempty" json:"keep_n,omitempty"`
	OlderThan        *string `url:"older_than,omitempty" json:"older_than,omitempty"`

	// Deprecated: NameRegexp is deprecated in favor of NameRegexpDelete.
	NameRegexp *string `url:"name_regex,omitempty" json:"name_regex,omitempty"`
}

DeleteRegistryRepositoryTagsOptions represents the available DeleteRegistryRepositoryTags() options.

GitLab API docs: https://docs.gitlab.com/api/container_registry/#delete-registry-repository-tags-in-bulk

type DeleteServiceAccountOptions added in v0.124.0 

type DeleteServiceAccountOptions struct {
	HardDelete *bool `url:"hard_delete,omitempty" json:"hard_delete,omitempty"`
}

DeleteServiceAccountOptions represents the available DeleteServiceAccount() options.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#delete-a-group-service-account

type DependenciesService added in v0.128.0 

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

DependenciesService handles communication with the dependencies related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/dependencies/

func (*DependenciesService) ListProjectDependencies added in v0.128.0 

func (s *DependenciesService) ListProjectDependencies(pid any, opt *ListProjectDependenciesOptions, options ...RequestOptionFunc) ([]*Dependency, *Response, error)

type DependenciesServiceInterface added in v0.128.0 

type DependenciesServiceInterface interface {
	// ListProjectDependencies Get a list of project dependencies. This API partially
	// mirroring Dependency List feature. This list can be generated only for languages
	// and package managers supported by Gemnasium.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/dependencies/#list-project-dependencies
	ListProjectDependencies(pid any, opt *ListProjectDependenciesOptions, options ...RequestOptionFunc) ([]*Dependency, *Response, error)
}

type Dependency added in v0.128.0 

type Dependency struct {
	Name               string                        `url:"name" json:"name"`
	Version            string                        `url:"version" json:"version"`
	PackageManager     DependencyPackageManagerValue `url:"package_manager" json:"package_manager"`
	DependencyFilePath string                        `url:"dependency_file_path" json:"dependency_file_path"`
	Vulnerabilities    []*DependencyVulnerability    `url:"vulnerabilities" json:"vulnerabilities"`
	Licenses           []*DependencyLicense          `url:"licenses" json:"licenses"`
}

Dependency represents a project dependency.

GitLab API docs: https://docs.gitlab.com/api/dependencies/

type DependencyLicense added in v0.128.0 

type DependencyLicense struct {
	Name string `url:"name" json:"name"`
	URL  string `url:"url" json:"url"`
}

DependencyLicense represents a project dependency license.

GitLab API docs: https://docs.gitlab.com/api/dependencies/

type DependencyListExport added in v0.116.0 

type DependencyListExport struct {
	ID          int64  `json:"id"`
	HasFinished bool   `json:"has_finished"`
	Self        string `json:"self"`
	Download    string `json:"download"`
}

DependencyListExport represents a request for a GitLab project's dependency list.

GitLab API docs: https://docs.gitlab.com/api/dependency_list_export/#create-a-dependency-list-export

type DependencyListExportService added in v0.116.0 

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

DependencyListExportService handles communication with the dependency list export related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/dependency_list_export/

func (*DependencyListExportService) CreateDependencyListExport added in v0.116.0 

func (s *DependencyListExportService) CreateDependencyListExport(pipelineID int64, opt *CreateDependencyListExportOptions, options ...RequestOptionFunc) (*DependencyListExport, *Response, error)

func (*DependencyListExportService) DownloadDependencyListExport added in v0.116.0 

func (s *DependencyListExportService) DownloadDependencyListExport(id int64, options ...RequestOptionFunc) (io.Reader, *Response, error)

func (*DependencyListExportService) GetDependencyListExport added in v0.116.0 

func (s *DependencyListExportService) GetDependencyListExport(id int64, options ...RequestOptionFunc) (*DependencyListExport, *Response, error)

type DependencyListExportServiceInterface added in v0.126.0 

type DependencyListExportServiceInterface interface {
	// CreateDependencyListExport creates a new CycloneDX JSON export for all the project dependencies
	// detected in a pipeline.
	//
	// If an authenticated user does not have permission to read_dependency, this request returns a 403
	// Forbidden status code.
	//
	// SBOM exports can be only accessed by the export’s author.
	//
	// GitLab docs:
	// https://docs.gitlab.com/api/dependency_list_export/#create-a-dependency-list-export
	CreateDependencyListExport(pipelineID int64, opt *CreateDependencyListExportOptions, options ...RequestOptionFunc) (*DependencyListExport, *Response, error)

	// GetDependencyListExport gets metadata about a single dependency list export.
	//
	// GitLab docs:
	// https://docs.gitlab.com/api/dependency_list_export/#get-single-dependency-list-export
	GetDependencyListExport(id int64, options ...RequestOptionFunc) (*DependencyListExport, *Response, error)

	// DownloadDependencyListExport downloads a single dependency list export.
	//
	// The github.com/CycloneDX/cyclonedx-go package can be used to parse the data from the returned io.Reader.
	//
	//	sbom := new(cdx.BOM)
	//	decoder := cdx.NewBOMDecoder(reader, cdx.BOMFileFormatJSON)
	//
	//	if err = decoder.Decode(sbom); err != nil {
	//		panic(err)
	//	}
	//
	// GitLab docs:
	// https://docs.gitlab.com/api/dependency_list_export/#download-dependency-list-export
	DownloadDependencyListExport(id int64, options ...RequestOptionFunc) (io.Reader, *Response, error)
}

type DependencyPackageManagerValue added in v0.128.0 

type DependencyPackageManagerValue string

DependencyPackageManagerValue represents a dependency package manager.

GitLab API docs: https://docs.gitlab.com/api/dependencies/ 

const (
	Bundler    DependencyPackageManagerValue = "bundler"
	Composer   DependencyPackageManagerValue = "composer"
	Conan      DependencyPackageManagerValue = "conan"
	Go         DependencyPackageManagerValue = "go"
	Gradle     DependencyPackageManagerValue = "gradle"
	Maven      DependencyPackageManagerValue = "maven"
	NPM        DependencyPackageManagerValue = "npm"
	NuGet      DependencyPackageManagerValue = "nuget"
	Pip        DependencyPackageManagerValue = "pip"
	Pipenv     DependencyPackageManagerValue = "pipenv"
	PNPM       DependencyPackageManagerValue = "pnpm"
	Yarn       DependencyPackageManagerValue = "yarn"
	SBT        DependencyPackageManagerValue = "sbt"
	Setuptools DependencyPackageManagerValue = "setuptools"
)

List of available package manager for dependencies

GitLab API docs: https://docs.gitlab.com/api/dependencies/

type DependencyProxyService added in v0.128.0 

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

DependencyProxyService handles communication with the dependency proxy related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/dependency_proxy/

func (*DependencyProxyService) PurgeGroupDependencyProxy added in v0.128.0 

func (s *DependencyProxyService) PurgeGroupDependencyProxy(gid any, options ...RequestOptionFunc) (*Response, error)

type DependencyProxyServiceInterface added in v0.128.0 

type DependencyProxyServiceInterface interface {
	// PurgeGroupDependencyProxy schedules for deletion the cached manifests and blobs
	// for a group. This endpoint requires the Owner role for the group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/dependency_proxy/#purge-the-dependency-proxy-for-a-group
	PurgeGroupDependencyProxy(gid any, options ...RequestOptionFunc) (*Response, error)
}

type DependencyVulnerability added in v0.128.0 

type DependencyVulnerability struct {
	Name     string `url:"name" json:"name"`
	Severity string `url:"severity" json:"severity"`
	ID       int64  `url:"id" json:"id"`
	URL      string `url:"url" json:"url"`
}

DependencyVulnerability represents a project dependency vulnerability.

GitLab API docs: https://docs.gitlab.com/api/dependencies/

type DeployKeyProject added in v0.116.0 

type DeployKeyProject struct {
	ID                int64      `json:"id"`
	Description       string     `json:"description"`
	Name              string     `json:"name"`
	NameWithNamespace string     `json:"name_with_namespace"`
	Path              string     `json:"path"`
	PathWithNamespace string     `json:"path_with_namespace"`
	CreatedAt         *time.Time `json:"created_at"`
}

DeployKeyProject refers to a project an InstanceDeployKey has write access to.

func (DeployKeyProject) String added in v0.116.0 

func (k DeployKeyProject) String() string

type DeployKeysService 

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

DeployKeysService handles communication with the keys related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/deploy_keys/

func (*DeployKeysService) AddDeployKey 

func (s *DeployKeysService) AddDeployKey(pid any, opt *AddDeployKeyOptions, options ...RequestOptionFunc) (*ProjectDeployKey, *Response, error)

func (*DeployKeysService) AddInstanceDeployKey added in v0.130.0 

func (s *DeployKeysService) AddInstanceDeployKey(opt *AddInstanceDeployKeyOptions, options ...RequestOptionFunc) (*InstanceDeployKey, *Response, error)

func (*DeployKeysService) DeleteDeployKey 

func (s *DeployKeysService) DeleteDeployKey(pid any, deployKey int64, options ...RequestOptionFunc) (*Response, error)

func (*DeployKeysService) EnableDeployKey added in v0.6.0 

func (s *DeployKeysService) EnableDeployKey(pid any, deployKey int64, options ...RequestOptionFunc) (*ProjectDeployKey, *Response, error)

func (*DeployKeysService) GetDeployKey 

func (s *DeployKeysService) GetDeployKey(pid any, deployKey int64, options ...RequestOptionFunc) (*ProjectDeployKey, *Response, error)

func (*DeployKeysService) ListAllDeployKeys added in v0.6.0 

func (s *DeployKeysService) ListAllDeployKeys(opt *ListInstanceDeployKeysOptions, options ...RequestOptionFunc) ([]*InstanceDeployKey, *Response, error)

func (*DeployKeysService) ListProjectDeployKeys added in v0.6.0 

func (s *DeployKeysService) ListProjectDeployKeys(pid any, opt *ListProjectDeployKeysOptions, options ...RequestOptionFunc) ([]*ProjectDeployKey, *Response, error)

func (*DeployKeysService) ListUserProjectDeployKeys added in v0.130.0 

func (s *DeployKeysService) ListUserProjectDeployKeys(uid any, opt *ListUserProjectDeployKeysOptions, options ...RequestOptionFunc) ([]*ProjectDeployKey, *Response, error)

ListUserProjectDeployKeys gets a list of a user's deploy keys.

uid can be either a user ID (int) or a username (string). If a username is provided with a leading "@" (e.g., "@johndoe"), it will be trimmed.

GitLab API docs: https://docs.gitlab.com/api/deploy_keys/#list-project-deploy-keys-for-user

func (*DeployKeysService) UpdateDeployKey added in v0.116.0 

func (s *DeployKeysService) UpdateDeployKey(pid any, deployKey int64, opt *UpdateDeployKeyOptions, options ...RequestOptionFunc) (*ProjectDeployKey, *Response, error)

type DeployKeysServiceInterface added in v0.126.0 

type DeployKeysServiceInterface interface {
	// ListAllDeployKeys gets a list of all deploy keys.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#list-all-deploy-keys
	// ListAllDeployKeys gets a list of all deploy keys.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#list-all-deploy-keys
	ListAllDeployKeys(opt *ListInstanceDeployKeysOptions, options ...RequestOptionFunc) ([]*InstanceDeployKey, *Response, error)

	// AddInstanceDeployKey creates a deploy key for the GitLab instance.
	// Requires administrator access.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#add-deploy-key
	AddInstanceDeployKey(opt *AddInstanceDeployKeyOptions, options ...RequestOptionFunc) (*InstanceDeployKey, *Response, error)

	// ListProjectDeployKeys gets a list of a project's deploy keys.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#list-deploy-keys-for-project
	ListProjectDeployKeys(pid any, opt *ListProjectDeployKeysOptions, options ...RequestOptionFunc) ([]*ProjectDeployKey, *Response, error)

	// ListUserProjectDeployKeys gets a list of a user's deploy keys.
	//
	// uid can be either a user ID (int) or a username (string). If a username
	// is provided with a leading "@" (e.g., "@johndoe"), it will be trimmed.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#list-project-deploy-keys-for-user
	ListUserProjectDeployKeys(uid any, opt *ListUserProjectDeployKeysOptions, options ...RequestOptionFunc) ([]*ProjectDeployKey, *Response, error)

	// GetDeployKey gets a single deploy key.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#get-a-single-deploy-key
	GetDeployKey(pid any, deployKey int64, options ...RequestOptionFunc) (*ProjectDeployKey, *Response, error)

	// AddDeployKey creates a new deploy key for a project. If the deploy key already
	// exists in another project, it will be joined to the project but only if
	// the original one is accessible by the same user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#add-deploy-key-for-a-project
	AddDeployKey(pid any, opt *AddDeployKeyOptions, options ...RequestOptionFunc) (*ProjectDeployKey, *Response, error)

	// DeleteDeployKey deletes a deploy key from a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#delete-deploy-key
	DeleteDeployKey(pid any, deployKey int64, options ...RequestOptionFunc) (*Response, error)

	// EnableDeployKey enables a deploy key.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#enable-a-deploy-key
	EnableDeployKey(pid any, deployKey int64, options ...RequestOptionFunc) (*ProjectDeployKey, *Response, error)

	// UpdateDeployKey updates a deploy key for a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_keys/#update-deploy-key
	UpdateDeployKey(pid any, deployKey int64, opt *UpdateDeployKeyOptions, options ...RequestOptionFunc) (*ProjectDeployKey, *Response, error)
}

type DeployToken added in v0.116.0 

type DeployToken struct {
	ID        int64      `json:"id"`
	Name      string     `json:"name"`
	Username  string     `json:"username"`
	ExpiresAt *time.Time `json:"expires_at"`
	Revoked   bool       `json:"revoked"`
	Expired   bool       `json:"expired"`
	Token     string     `json:"token,omitempty"`
	Scopes    []string   `json:"scopes"`
}

DeployToken represents a GitLab deploy token.

func (DeployToken) String added in v0.116.0 

func (k DeployToken) String() string

type DeployTokensService added in v0.116.0 

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

DeployTokensService handles communication with the deploy tokens related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/deploy_tokens/

func (*DeployTokensService) CreateGroupDeployToken added in v0.116.0 

func (s *DeployTokensService) CreateGroupDeployToken(gid any, opt *CreateGroupDeployTokenOptions, options ...RequestOptionFunc) (*DeployToken, *Response, error)

func (*DeployTokensService) CreateProjectDeployToken added in v0.116.0 

func (s *DeployTokensService) CreateProjectDeployToken(pid any, opt *CreateProjectDeployTokenOptions, options ...RequestOptionFunc) (*DeployToken, *Response, error)

func (*DeployTokensService) DeleteGroupDeployToken added in v0.116.0 

func (s *DeployTokensService) DeleteGroupDeployToken(gid any, deployToken int64, options ...RequestOptionFunc) (*Response, error)

func (*DeployTokensService) DeleteProjectDeployToken added in v0.116.0 

func (s *DeployTokensService) DeleteProjectDeployToken(pid any, deployToken int64, options ...RequestOptionFunc) (*Response, error)

func (*DeployTokensService) GetGroupDeployToken added in v0.116.0 

func (s *DeployTokensService) GetGroupDeployToken(gid any, deployToken int64, options ...RequestOptionFunc) (*DeployToken, *Response, error)

func (*DeployTokensService) GetProjectDeployToken added in v0.116.0 

func (s *DeployTokensService) GetProjectDeployToken(pid any, deployToken int64, options ...RequestOptionFunc) (*DeployToken, *Response, error)

func (*DeployTokensService) ListAllDeployTokens added in v0.116.0 

func (s *DeployTokensService) ListAllDeployTokens(options ...RequestOptionFunc) ([]*DeployToken, *Response, error)

func (*DeployTokensService) ListGroupDeployTokens added in v0.116.0 

func (s *DeployTokensService) ListGroupDeployTokens(gid any, opt *ListGroupDeployTokensOptions, options ...RequestOptionFunc) ([]*DeployToken, *Response, error)

func (*DeployTokensService) ListProjectDeployTokens added in v0.116.0 

func (s *DeployTokensService) ListProjectDeployTokens(pid any, opt *ListProjectDeployTokensOptions, options ...RequestOptionFunc) ([]*DeployToken, *Response, error)

type DeployTokensServiceInterface added in v0.126.0 

type DeployTokensServiceInterface interface {
	// ListAllDeployTokens gets a list of all deploy tokens.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#list-all-deploy-tokens
	// ListAllDeployTokens gets a list of all deploy tokens.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#list-all-deploy-tokens
	ListAllDeployTokens(options ...RequestOptionFunc) ([]*DeployToken, *Response, error)

	// ListProjectDeployTokens gets a list of a project's deploy tokens.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#list-project-deploy-tokens
	ListProjectDeployTokens(pid any, opt *ListProjectDeployTokensOptions, options ...RequestOptionFunc) ([]*DeployToken, *Response, error)

	// GetProjectDeployToken gets a single deploy token.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#get-a-project-deploy-token
	GetProjectDeployToken(pid any, deployToken int64, options ...RequestOptionFunc) (*DeployToken, *Response, error)

	// CreateProjectDeployToken creates a new deploy token for a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#create-a-project-deploy-token
	CreateProjectDeployToken(pid any, opt *CreateProjectDeployTokenOptions, options ...RequestOptionFunc) (*DeployToken, *Response, error)

	// DeleteProjectDeployToken removes a deploy token from the project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#delete-a-project-deploy-token
	DeleteProjectDeployToken(pid any, deployToken int64, options ...RequestOptionFunc) (*Response, error)

	// ListGroupDeployTokens gets a list of a group’s deploy tokens.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#list-group-deploy-tokens
	ListGroupDeployTokens(gid any, opt *ListGroupDeployTokensOptions, options ...RequestOptionFunc) ([]*DeployToken, *Response, error)

	// GetGroupDeployToken gets a single deploy token.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#get-a-group-deploy-token
	GetGroupDeployToken(gid any, deployToken int64, options ...RequestOptionFunc) (*DeployToken, *Response, error)

	// CreateGroupDeployToken creates a new deploy token for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#create-a-group-deploy-token
	CreateGroupDeployToken(gid any, opt *CreateGroupDeployTokenOptions, options ...RequestOptionFunc) (*DeployToken, *Response, error)

	// DeleteGroupDeployToken removes a deploy token from the group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deploy_tokens/#delete-a-group-deploy-token
	DeleteGroupDeployToken(gid any, deployToken int64, options ...RequestOptionFunc) (*Response, error)
}

type Deployment added in v0.8.1 

type Deployment struct {
	ID          int64                `json:"id"`
	IID         int64                `json:"iid"`
	Ref         string               `json:"ref"`
	SHA         string               `json:"sha"`
	Status      string               `json:"status"`
	CreatedAt   *time.Time           `json:"created_at"`
	UpdatedAt   *time.Time           `json:"updated_at"`
	User        *ProjectUser         `json:"user"`
	Environment *Environment         `json:"environment"`
	Deployable  DeploymentDeployable `json:"deployable"`
}

Deployment represents the GitLab deployment

type DeploymentApprovalStatus added in v0.116.0 

type DeploymentApprovalStatus string

DeploymentApprovalStatus represents a GitLab deployment approval status. 

const (
	DeploymentApprovalStatusApproved DeploymentApprovalStatus = "approved"
	DeploymentApprovalStatusRejected DeploymentApprovalStatus = "rejected"
)

These constants represent all valid deployment approval statuses.

type DeploymentDeployable added in v1.0.0 

type DeploymentDeployable struct {
	ID         int64                        `json:"id"`
	Status     string                       `json:"status"`
	Stage      string                       `json:"stage"`
	Name       string                       `json:"name"`
	Ref        string                       `json:"ref"`
	Tag        bool                         `json:"tag"`
	Coverage   float64                      `json:"coverage"`
	CreatedAt  *time.Time                   `json:"created_at"`
	StartedAt  *time.Time                   `json:"started_at"`
	FinishedAt *time.Time                   `json:"finished_at"`
	Duration   float64                      `json:"duration"`
	User       *User                        `json:"user"`
	Commit     *Commit                      `json:"commit"`
	Pipeline   DeploymentDeployablePipeline `json:"pipeline"`
	Runner     *Runner                      `json:"runner"`
}

DeploymentDeployable represents the Gitlab deployment deployable

type DeploymentDeployablePipeline added in v1.0.0 

type DeploymentDeployablePipeline struct {
	ID        int64      `json:"id"`
	SHA       string     `json:"sha"`
	Ref       string     `json:"ref"`
	Status    string     `json:"status"`
	CreatedAt *time.Time `json:"created_at"`
	UpdatedAt *time.Time `json:"updated_at"`
}

DeploymentDeployablePipeline represents the Gitlab deployment deployable pipeline

type DeploymentEvent added in v0.116.0 

type DeploymentEvent struct {
	ObjectKind             string                 `json:"object_kind"`
	Status                 string                 `json:"status"`
	StatusChangedAt        string                 `json:"status_changed_at"`
	DeploymentID           int64                  `json:"deployment_id"`
	DeployableID           int64                  `json:"deployable_id"`
	DeployableURL          string                 `json:"deployable_url"`
	Environment            string                 `json:"environment"`
	EnvironmentSlug        string                 `json:"environment_slug"`
	EnvironmentExternalURL string                 `json:"environment_external_url"`
	Project                DeploymentEventProject `json:"project"`
	Ref                    string                 `json:"ref"`
	ShortSHA               string                 `json:"short_sha"`
	User                   *EventUser             `json:"user"`
	UserURL                string                 `json:"user_url"`
	CommitURL              string                 `json:"commit_url"`
	CommitTitle            string                 `json:"commit_title"`
}

DeploymentEvent represents a deployment event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#deployment-events

type DeploymentEventProject added in v1.0.0 

type DeploymentEventProject struct {
	ID                int64   `json:"id"`
	Name              string  `json:"name"`
	Description       string  `json:"description"`
	AvatarURL         *string `json:"avatar_url"`
	GitSSHURL         string  `json:"git_ssh_url"`
	GitHTTPURL        string  `json:"git_http_url"`
	Namespace         string  `json:"namespace"`
	PathWithNamespace string  `json:"path_with_namespace"`
	DefaultBranch     string  `json:"default_branch"`
	Homepage          string  `json:"homepage"`
	URL               string  `json:"url"`
	SSHURL            string  `json:"ssh_url"`
	HTTPURL           string  `json:"http_url"`
	WebURL            string  `json:"web_url"`
	VisibilityLevel   int64   `json:"visibility_level"`
	CIConfigPath      string  `json:"ci_config_path"`
}

type DeploymentMergeRequestsService added in v0.116.0 

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

DeploymentMergeRequestsService handles communication with the deployment's merge requests related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/deployments/#list-of-merge-requests-associated-with-a-deployment

func (*DeploymentMergeRequestsService) ListDeploymentMergeRequests added in v0.116.0 

func (s *DeploymentMergeRequestsService) ListDeploymentMergeRequests(pid any, deployment int64, opts *ListMergeRequestsOptions, options ...RequestOptionFunc) ([]*MergeRequest, *Response, error)

type DeploymentMergeRequestsServiceInterface added in v0.126.0 

type DeploymentMergeRequestsServiceInterface interface {
	// ListDeploymentMergeRequests get the merge requests associated with deployment.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deployments/#list-of-merge-requests-associated-with-a-deployment
	ListDeploymentMergeRequests(pid any, deployment int64, opts *ListMergeRequestsOptions, options ...RequestOptionFunc) ([]*MergeRequest, *Response, error)
}

DeploymentMergeRequestsServiceInterface defines all the API methods for the DeploymentMergeRequestsService

type DeploymentStatusValue added in v0.116.0 

type DeploymentStatusValue string

DeploymentStatusValue represents a GitLab deployment status. 

const (
	DeploymentStatusCreated  DeploymentStatusValue = "created"
	DeploymentStatusRunning  DeploymentStatusValue = "running"
	DeploymentStatusSuccess  DeploymentStatusValue = "success"
	DeploymentStatusFailed   DeploymentStatusValue = "failed"
	DeploymentStatusCanceled DeploymentStatusValue = "canceled"
)

These constants represent all valid deployment statuses.

type DeploymentsService added in v0.8.1 

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

DeploymentsService handles communication with the deployment related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/deployments/

func (*DeploymentsService) ApproveOrRejectProjectDeployment added in v0.116.0 

func (s *DeploymentsService) ApproveOrRejectProjectDeployment(pid any, deployment int64, opt *ApproveOrRejectProjectDeploymentOptions, options ...RequestOptionFunc) (*Response, error)

func (*DeploymentsService) CreateProjectDeployment added in v0.116.0 

func (s *DeploymentsService) CreateProjectDeployment(pid any, opt *CreateProjectDeploymentOptions, options ...RequestOptionFunc) (*Deployment, *Response, error)

func (*DeploymentsService) DeleteProjectDeployment added in v0.116.0 

func (s *DeploymentsService) DeleteProjectDeployment(pid any, deployment int64, options ...RequestOptionFunc) (*Response, error)

func (*DeploymentsService) GetProjectDeployment added in v0.8.1 

func (s *DeploymentsService) GetProjectDeployment(pid any, deployment int64, options ...RequestOptionFunc) (*Deployment, *Response, error)

func (*DeploymentsService) ListProjectDeployments added in v0.8.1 

func (s *DeploymentsService) ListProjectDeployments(pid any, opts *ListProjectDeploymentsOptions, options ...RequestOptionFunc) ([]*Deployment, *Response, error)

func (*DeploymentsService) UpdateProjectDeployment added in v0.116.0 

func (s *DeploymentsService) UpdateProjectDeployment(pid any, deployment int64, opt *UpdateProjectDeploymentOptions, options ...RequestOptionFunc) (*Deployment, *Response, error)

type DeploymentsServiceInterface added in v0.126.0 

type DeploymentsServiceInterface interface {
	// ListProjectDeployments gets a list of deployments in a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deployments/#list-project-deployments
	// ListProjectDeployments gets a list of deployments in a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deployments/#list-project-deployments
	ListProjectDeployments(pid any, opts *ListProjectDeploymentsOptions, options ...RequestOptionFunc) ([]*Deployment, *Response, error)

	// GetProjectDeployment gets a specific deployment for a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deployments/#get-a-specific-deployment
	GetProjectDeployment(pid any, deployment int64, options ...RequestOptionFunc) (*Deployment, *Response, error)

	// CreateProjectDeployment creates a project deployment.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deployments/#create-a-deployment
	CreateProjectDeployment(pid any, opt *CreateProjectDeploymentOptions, options ...RequestOptionFunc) (*Deployment, *Response, error)

	// UpdateProjectDeployment updates a project deployment.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deployments/#update-a-deployment
	UpdateProjectDeployment(pid any, deployment int64, opt *UpdateProjectDeploymentOptions, options ...RequestOptionFunc) (*Deployment, *Response, error)

	// ApproveOrRejectProjectDeployment approves or rejects a blocked deployment.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deployments/#approve-or-reject-a-blocked-deployment
	ApproveOrRejectProjectDeployment(pid any, deployment int64, opt *ApproveOrRejectProjectDeploymentOptions, options ...RequestOptionFunc) (*Response, error)

	// DeleteProjectDeployment deletes a specific deployment.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/deployments/#delete-a-specific-deployment
	DeleteProjectDeployment(pid any, deployment int64, options ...RequestOptionFunc) (*Response, error)
}

DeploymentsServiceInterface defines all the API methods for the DeploymentsService

type DetailedStatus added in v0.116.0 

type DetailedStatus struct {
	Icon         string                     `json:"icon"`
	Text         string                     `json:"text"`
	Label        string                     `json:"label"`
	Group        string                     `json:"group"`
	Tooltip      string                     `json:"tooltip"`
	HasDetails   bool                       `json:"has_details"`
	DetailsPath  string                     `json:"details_path"`
	Illustration DetailedStatusIllustration `json:"illustration"`
	Favicon      string                     `json:"favicon"`
}

DetailedStatus contains detailed information about the status of a pipeline.

func (DetailedStatus) String added in v1.0.0 

func (s DetailedStatus) String() string

type DetailedStatusIllustration added in v1.0.0 

type DetailedStatusIllustration struct {
	Image string `json:"image"`
}

DetailedStatusIllustration contains detailed information about the status illustration of a pipeline.

func (DetailedStatusIllustration) String added in v1.0.0 

func (i DetailedStatusIllustration) String() string

type Diff 

type Diff struct {
	Diff        string `json:"diff"`
	NewPath     string `json:"new_path"`
	OldPath     string `json:"old_path"`
	AMode       string `json:"a_mode"`
	BMode       string `json:"b_mode"`
	NewFile     bool   `json:"new_file"`
	RenamedFile bool   `json:"renamed_file"`
	DeletedFile bool   `json:"deleted_file"`
}

Diff represents a GitLab diff.

GitLab API docs: https://docs.gitlab.com/api/commits/

func (Diff) String 

func (d Diff) String() string

type DiscordIntegration added in v1.19.0 

type DiscordIntegration struct {
	Integration
	Properties DiscordIntegrationProperties `json:"properties"`
}

DiscordIntegration represents the Discord integration settings.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#discord

type DiscordIntegrationProperties added in v1.19.0 

type DiscordIntegrationProperties struct {
	NotifyOnlyBrokenPipelines bool   `json:"notify_only_broken_pipelines,omitempty"`
	BranchesToBeNotified      string `json:"branches_to_be_notified,omitempty"`
}

DiscordIntegrationProperties represents Discord specific properties.

type DiscordService added in v0.116.0 

type DiscordService struct {
	Service
	Properties *DiscordServiceProperties `json:"properties"`
}

DiscordService represents Discord service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#discord-notifications

type DiscordServiceProperties added in v0.116.0 

type DiscordServiceProperties struct {
	BranchesToBeNotified      string `url:"branches_to_be_notified,omitempty" json:"branches_to_be_notified,omitempty"`
	NotifyOnlyBrokenPipelines bool   `url:"notify_only_broken_pipelines,omitempty" json:"notify_only_broken_pipelines,omitempty"`
}

DiscordServiceProperties represents Discord specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#discord-notifications

type Discussion added in v0.11.2 

type Discussion struct {
	ID             string  `json:"id"`
	IndividualNote bool    `json:"individual_note"`
	Notes          []*Note `json:"notes"`
}

Discussion represents a GitLab discussion.

GitLab API docs: https://docs.gitlab.com/api/discussions/

func (Discussion) String added in v0.11.2 

func (d Discussion) String() string

type DiscussionsService added in v0.11.2 

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

DiscussionsService handles communication with the discussions related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/discussions/

func (*DiscussionsService) AddCommitDiscussionNote added in v0.11.2 

func (s *DiscussionsService) AddCommitDiscussionNote(pid any, commit string, discussion string, opt *AddCommitDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

func (*DiscussionsService) AddEpicDiscussionNote added in v0.11.2 

func (s *DiscussionsService) AddEpicDiscussionNote(gid any, epic int64, discussion string, opt *AddEpicDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

func (*DiscussionsService) AddIssueDiscussionNote added in v0.11.2 

func (s *DiscussionsService) AddIssueDiscussionNote(pid any, issue int64, discussion string, opt *AddIssueDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

func (*DiscussionsService) AddMergeRequestDiscussionNote added in v0.11.2 

func (s *DiscussionsService) AddMergeRequestDiscussionNote(pid any, mergeRequest int64, discussion string, opt *AddMergeRequestDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

func (*DiscussionsService) AddSnippetDiscussionNote added in v0.11.2 

func (s *DiscussionsService) AddSnippetDiscussionNote(pid any, snippet int64, discussion string, opt *AddSnippetDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

func (*DiscussionsService) CreateCommitDiscussion added in v0.11.2 

func (s *DiscussionsService) CreateCommitDiscussion(pid any, commit string, opt *CreateCommitDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) CreateEpicDiscussion added in v0.11.2 

func (s *DiscussionsService) CreateEpicDiscussion(gid any, epic int64, opt *CreateEpicDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) CreateIssueDiscussion added in v0.11.2 

func (s *DiscussionsService) CreateIssueDiscussion(pid any, issue int64, opt *CreateIssueDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) CreateMergeRequestDiscussion added in v0.11.2 

func (s *DiscussionsService) CreateMergeRequestDiscussion(pid any, mergeRequest int64, opt *CreateMergeRequestDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) CreateSnippetDiscussion added in v0.11.2 

func (s *DiscussionsService) CreateSnippetDiscussion(pid any, snippet int64, opt *CreateSnippetDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) DeleteCommitDiscussionNote added in v0.11.2 

func (s *DiscussionsService) DeleteCommitDiscussionNote(pid any, commit string, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)

func (*DiscussionsService) DeleteEpicDiscussionNote added in v0.11.2 

func (s *DiscussionsService) DeleteEpicDiscussionNote(gid any, epic int64, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)

func (*DiscussionsService) DeleteIssueDiscussionNote added in v0.11.2 

func (s *DiscussionsService) DeleteIssueDiscussionNote(pid any, issue int64, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)

func (*DiscussionsService) DeleteMergeRequestDiscussionNote added in v0.11.2 

func (s *DiscussionsService) DeleteMergeRequestDiscussionNote(pid any, mergeRequest int64, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)

func (*DiscussionsService) DeleteSnippetDiscussionNote added in v0.11.2 

func (s *DiscussionsService) DeleteSnippetDiscussionNote(pid any, snippet int64, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)

func (*DiscussionsService) GetCommitDiscussion added in v0.11.2 

func (s *DiscussionsService) GetCommitDiscussion(pid any, commit string, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) GetEpicDiscussion added in v0.11.2 

func (s *DiscussionsService) GetEpicDiscussion(gid any, epic int64, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) GetIssueDiscussion added in v0.11.2 

func (s *DiscussionsService) GetIssueDiscussion(pid any, issue int64, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) GetMergeRequestDiscussion added in v0.11.2 

func (s *DiscussionsService) GetMergeRequestDiscussion(pid any, mergeRequest int64, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) GetSnippetDiscussion added in v0.11.2 

func (s *DiscussionsService) GetSnippetDiscussion(pid any, snippet int64, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) ListCommitDiscussions added in v0.11.2 

func (s *DiscussionsService) ListCommitDiscussions(pid any, commit string, opt *ListCommitDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

func (*DiscussionsService) ListGroupEpicDiscussions added in v0.11.2 

func (s *DiscussionsService) ListGroupEpicDiscussions(gid any, epic int64, opt *ListGroupEpicDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

func (*DiscussionsService) ListIssueDiscussions added in v0.11.2 

func (s *DiscussionsService) ListIssueDiscussions(pid any, issue int64, opt *ListIssueDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

func (*DiscussionsService) ListMergeRequestDiscussions added in v0.11.2 

func (s *DiscussionsService) ListMergeRequestDiscussions(pid any, mergeRequest int64, opt *ListMergeRequestDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

func (*DiscussionsService) ListSnippetDiscussions added in v0.11.2 

func (s *DiscussionsService) ListSnippetDiscussions(pid any, snippet int64, opt *ListSnippetDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

func (*DiscussionsService) ResolveMergeRequestDiscussion added in v0.11.2 

func (s *DiscussionsService) ResolveMergeRequestDiscussion(pid any, mergeRequest int64, discussion string, opt *ResolveMergeRequestDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

func (*DiscussionsService) UpdateCommitDiscussionNote added in v0.11.2 

func (s *DiscussionsService) UpdateCommitDiscussionNote(pid any, commit string, discussion string, note int64, opt *UpdateCommitDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

func (*DiscussionsService) UpdateEpicDiscussionNote added in v0.11.2 

func (s *DiscussionsService) UpdateEpicDiscussionNote(gid any, epic int64, discussion string, note int64, opt *UpdateEpicDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

func (*DiscussionsService) UpdateIssueDiscussionNote added in v0.11.2 

func (s *DiscussionsService) UpdateIssueDiscussionNote(pid any, issue int64, discussion string, note int64, opt *UpdateIssueDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

func (*DiscussionsService) UpdateMergeRequestDiscussionNote added in v0.11.2 

func (s *DiscussionsService) UpdateMergeRequestDiscussionNote(pid any, mergeRequest int64, discussion string, note int64, opt *UpdateMergeRequestDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

func (*DiscussionsService) UpdateSnippetDiscussionNote added in v0.11.2 

func (s *DiscussionsService) UpdateSnippetDiscussionNote(pid any, snippet int64, discussion string, note int64, opt *UpdateSnippetDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

type DiscussionsServiceInterface added in v0.126.0 

type DiscussionsServiceInterface interface {
	// ListIssueDiscussions gets a list of all discussions for a single issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#list-project-issue-discussion-items
	ListIssueDiscussions(pid any, issue int64, opt *ListIssueDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

	// GetIssueDiscussion returns a single discussion for a specific project issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#get-single-issue-discussion-item
	GetIssueDiscussion(pid any, issue int64, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// CreateIssueDiscussion creates a new discussion to a single project issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#create-new-issue-thread
	CreateIssueDiscussion(pid any, issue int64, opt *CreateIssueDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// AddIssueDiscussionNote creates a new note in an existing discussion of an issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#add-note-to-existing-issue-thread
	AddIssueDiscussionNote(pid any, issue int64, discussion string, opt *AddIssueDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// UpdateIssueDiscussionNote modifies an existing note in a discussion of an issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#modify-existing-issue-thread-note
	UpdateIssueDiscussionNote(pid any, issue int64, discussion string, note int64, opt *UpdateIssueDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// DeleteIssueDiscussionNote deletes a note from a discussion of an issue.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#delete-an-issue-thread-note
	DeleteIssueDiscussionNote(pid any, issue int64, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)

	// ListSnippetDiscussions gets all discussions for a snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#list-project-snippet-discussion-items
	ListSnippetDiscussions(pid any, snippet int64, opt *ListSnippetDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

	// GetSnippetDiscussion returns a single discussion for a snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#get-single-snippet-discussion-item
	GetSnippetDiscussion(pid any, snippet int64, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// CreateSnippetDiscussion creates a new discussion for a snippet.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#create-new-snippet-thread
	CreateSnippetDiscussion(pid any, snippet int64, opt *CreateSnippetDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// AddSnippetDiscussionNote adds a new note to a snippet discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#add-note-to-existing-snippet-thread
	AddSnippetDiscussionNote(pid any, snippet int64, discussion string, opt *AddSnippetDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// UpdateSnippetDiscussionNote modifies an existing note in a snippet discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#modify-existing-snippet-thread-note
	UpdateSnippetDiscussionNote(pid any, snippet int64, discussion string, note int64, opt *UpdateSnippetDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// DeleteSnippetDiscussionNote deletes a note from a snippet discussion.
	//
	// GitLab API docs: https://docs.gitlab.com/api/discussions/#delete-a-snippet-thread-note
	DeleteSnippetDiscussionNote(pid any, snippet int64, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)

	// ListGroupEpicDiscussions gets all discussions for a group epic.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#list-group-epic-discussion-items
	ListGroupEpicDiscussions(gid any, epic int64, opt *ListGroupEpicDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

	// GetEpicDiscussion returns a single discussion for a group epic.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#get-single-epic-discussion-item
	GetEpicDiscussion(gid any, epic int64, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// CreateEpicDiscussion creates a new discussion for a group epic.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#create-new-epic-thread
	CreateEpicDiscussion(gid any, epic int64, opt *CreateEpicDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// AddEpicDiscussionNote adds a new note to an epic discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#add-note-to-existing-epic-thread
	AddEpicDiscussionNote(gid any, epic int64, discussion string, opt *AddEpicDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// UpdateEpicDiscussionNote modifies an existing note in an epic discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#modify-existing-epic-thread-note
	UpdateEpicDiscussionNote(gid any, epic int64, discussion string, note int64, opt *UpdateEpicDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// DeleteEpicDiscussionNote deletes a note from an epic discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#delete-an-epic-thread-note
	DeleteEpicDiscussionNote(gid any, epic int64, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)

	// ListMergeRequestDiscussions gets all discussions for a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#list-project-merge-request-discussion-items
	ListMergeRequestDiscussions(pid any, mergeRequest int64, opt *ListMergeRequestDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

	// GetMergeRequestDiscussion returns a single discussion for a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#get-single-merge-request-discussion-item
	GetMergeRequestDiscussion(pid any, mergeRequest int64, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// CreateMergeRequestDiscussion creates a new discussion for a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#create-new-merge-request-thread
	CreateMergeRequestDiscussion(pid any, mergeRequest int64, opt *CreateMergeRequestDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// ResolveMergeRequestDiscussion resolves or unresolves a merge request discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#resolve-a-merge-request-thread
	ResolveMergeRequestDiscussion(pid any, mergeRequest int64, discussion string, opt *ResolveMergeRequestDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// AddMergeRequestDiscussionNote adds a new note to a merge request discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#add-note-to-existing-merge-request-thread
	AddMergeRequestDiscussionNote(pid any, mergeRequest int64, discussion string, opt *AddMergeRequestDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// UpdateMergeRequestDiscussionNote modifies an existing note in a merge request discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#modify-an-existing-merge-request-thread-note
	UpdateMergeRequestDiscussionNote(pid any, mergeRequest int64, discussion string, note int64, opt *UpdateMergeRequestDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// DeleteMergeRequestDiscussionNote deletes a note from a merge request discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#delete-a-merge-request-thread-note
	DeleteMergeRequestDiscussionNote(pid any, mergeRequest int64, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)

	// ListCommitDiscussions gets all discussions for a commit.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#list-project-commit-discussion-items
	ListCommitDiscussions(pid any, commit string, opt *ListCommitDiscussionsOptions, options ...RequestOptionFunc) ([]*Discussion, *Response, error)

	// GetCommitDiscussion returns a single discussion for a commit.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#get-single-commit-discussion-item
	GetCommitDiscussion(pid any, commit string, discussion string, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// CreateCommitDiscussion creates a new discussion for a commit.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#create-new-commit-thread
	CreateCommitDiscussion(pid any, commit string, opt *CreateCommitDiscussionOptions, options ...RequestOptionFunc) (*Discussion, *Response, error)

	// AddCommitDiscussionNote adds a new note to a commit discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#add-note-to-existing-commit-thread
	AddCommitDiscussionNote(pid any, commit string, discussion string, opt *AddCommitDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// UpdateCommitDiscussionNote modifies an existing note in a commit discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#modify-an-existing-commit-thread-note
	UpdateCommitDiscussionNote(pid any, commit string, discussion string, note int64, opt *UpdateCommitDiscussionNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

	// DeleteCommitDiscussionNote deletes a note from a commit discussion.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/discussions/#delete-a-commit-thread-note
	DeleteCommitDiscussionNote(pid any, commit string, discussion string, note int64, options ...RequestOptionFunc) (*Response, error)
}

DiscussionsServiceInterface defines all the API methods for the DiscussionsService

type DockerfileTemplate added in v0.116.0 

type DockerfileTemplate struct {
	Name    string `json:"name"`
	Content string `json:"content"`
}

DockerfileTemplate represents a GitLab Dockerfile template.

GitLab API docs: https://docs.gitlab.com/api/templates/dockerfiles/

type DockerfileTemplateListItem added in v0.116.0 

type DockerfileTemplateListItem struct {
	Key  string `json:"key"`
	Name string `json:"name"`
}

DockerfileTemplateListItem represents a GitLab Dockerfile template from the list.

GitLab API docs: https://docs.gitlab.com/api/templates/dockerfiles/

type DockerfileTemplatesService added in v0.116.0 

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

DockerfileTemplatesService handles communication with the Dockerfile templates related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/templates/dockerfiles/

func (*DockerfileTemplatesService) GetTemplate added in v0.116.0 

func (s *DockerfileTemplatesService) GetTemplate(key string, options ...RequestOptionFunc) (*DockerfileTemplate, *Response, error)

func (*DockerfileTemplatesService) ListTemplates added in v0.116.0 

func (s *DockerfileTemplatesService) ListTemplates(opt *ListDockerfileTemplatesOptions, options ...RequestOptionFunc) ([]*DockerfileTemplateListItem, *Response, error)

type DockerfileTemplatesServiceInterface added in v0.126.0 

type DockerfileTemplatesServiceInterface interface {
	// ListTemplates get a list of available Dockerfile templates.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/templates/dockerfiles/#list-dockerfile-templates
	ListTemplates(opt *ListDockerfileTemplatesOptions, options ...RequestOptionFunc) ([]*DockerfileTemplateListItem, *Response, error)

	// GetTemplate get a single Dockerfile template.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/templates/dockerfiles/#single-dockerfile-template
	GetTemplate(key string, options ...RequestOptionFunc) (*DockerfileTemplate, *Response, error)
}

DockerfileTemplatesServiceInterface defines all the API methods for the DockerfileTemplatesService

type DownloadArtifactsFileOptions added in v0.116.0 

type DownloadArtifactsFileOptions struct {
	Job *string `url:"job" json:"job"`
}

DownloadArtifactsFileOptions represents the available DownloadArtifactsFile() options.

GitLab API docs: https://docs.gitlab.com/api/job_artifacts/#download-the-artifacts-archive

type DraftNote added in v0.116.0 

type DraftNote struct {
	ID                int64         `json:"id"`
	AuthorID          int64         `json:"author_id"`
	MergeRequestID    int64         `json:"merge_request_id"`
	ResolveDiscussion bool          `json:"resolve_discussion"`
	DiscussionID      string        `json:"discussion_id"`
	Note              string        `json:"note"`
	CommitID          string        `json:"commit_id"`
	LineCode          string        `json:"line_code"`
	Position          *NotePosition `json:"position"`
}

type DraftNotesService added in v0.116.0 

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

DraftNotesService handles communication with the draft notes related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/draft_notes/#list-all-merge-request-draft-notes

func (*DraftNotesService) CreateDraftNote added in v0.116.0 

func (s *DraftNotesService) CreateDraftNote(pid any, mergeRequest int64, opt *CreateDraftNoteOptions, options ...RequestOptionFunc) (*DraftNote, *Response, error)

func (*DraftNotesService) DeleteDraftNote added in v0.116.0 

func (s *DraftNotesService) DeleteDraftNote(pid any, mergeRequest int64, note int64, options ...RequestOptionFunc) (*Response, error)

func (*DraftNotesService) GetDraftNote added in v0.116.0 

func (s *DraftNotesService) GetDraftNote(pid any, mergeRequest int64, note int64, options ...RequestOptionFunc) (*DraftNote, *Response, error)

func (*DraftNotesService) ListDraftNotes added in v0.116.0 

func (s *DraftNotesService) ListDraftNotes(pid any, mergeRequest int64, opt *ListDraftNotesOptions, options ...RequestOptionFunc) ([]*DraftNote, *Response, error)

func (*DraftNotesService) PublishAllDraftNotes added in v0.116.0 

func (s *DraftNotesService) PublishAllDraftNotes(pid any, mergeRequest int64, options ...RequestOptionFunc) (*Response, error)

func (*DraftNotesService) PublishDraftNote added in v0.116.0 

func (s *DraftNotesService) PublishDraftNote(pid any, mergeRequest int64, note int64, options ...RequestOptionFunc) (*Response, error)

func (*DraftNotesService) UpdateDraftNote added in v0.116.0 

func (s *DraftNotesService) UpdateDraftNote(pid any, mergeRequest int64, note int64, opt *UpdateDraftNoteOptions, options ...RequestOptionFunc) (*DraftNote, *Response, error)

type DraftNotesServiceInterface added in v0.126.0 

type DraftNotesServiceInterface interface {
	// ListDraftNotes gets a list of all draft notes for a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/draft_notes/#list-all-merge-request-draft-notes
	ListDraftNotes(pid any, mergeRequest int64, opt *ListDraftNotesOptions, options ...RequestOptionFunc) ([]*DraftNote, *Response, error)

	// GetDraftNote gets a single draft note for a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/draft_notes/#get-a-single-draft-note
	GetDraftNote(pid any, mergeRequest int64, note int64, options ...RequestOptionFunc) (*DraftNote, *Response, error)

	// CreateDraftNote creates a draft note for a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/draft_notes/#create-a-draft-note
	CreateDraftNote(pid any, mergeRequest int64, opt *CreateDraftNoteOptions, options ...RequestOptionFunc) (*DraftNote, *Response, error)

	// UpdateDraftNote updates a draft note for a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/draft_notes/#update-a-draft-note
	UpdateDraftNote(pid any, mergeRequest int64, note int64, opt *UpdateDraftNoteOptions, options ...RequestOptionFunc) (*DraftNote, *Response, error)

	// DeleteDraftNote deletes a single draft note for a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/draft_notes/#delete-a-draft-note
	DeleteDraftNote(pid any, mergeRequest int64, note int64, options ...RequestOptionFunc) (*Response, error)

	// PublishDraftNote publishes a single draft note for a merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/draft_notes/#publish-a-draft-note
	PublishDraftNote(pid any, mergeRequest int64, note int64, options ...RequestOptionFunc) (*Response, error)

	// PublishAllDraftNotes publishes all draft notes for a merge request that belong to the user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/draft_notes/#publish-a-draft-note
	PublishAllDraftNotes(pid any, mergeRequest int64, options ...RequestOptionFunc) (*Response, error)
}

DraftNotesServiceInterface defines all the API methods for the DraftNotesService

type DroneCIService 

type DroneCIService struct {
	Service
	Properties *DroneCIServiceProperties `json:"properties"`
}

DroneCIService represents Drone CI service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#drone

type DroneCIServiceProperties 

type DroneCIServiceProperties struct {
	DroneURL              string `json:"drone_url"`
	EnableSSLVerification bool   `json:"enable_ssl_verification"`
}

DroneCIServiceProperties represents Drone CI specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#drone

type DuoAvailabilityValue added in v1.40.1 

type DuoAvailabilityValue string

DuoAvailabilityValue represents a GitLab Duo availability value. 

const (
	DuoAvailabilityDefaultOn  DuoAvailabilityValue = "default_on"
	DuoAvailabilityDefaultOff DuoAvailabilityValue = "default_off"
	DuoAvailabilityNeverOn    DuoAvailabilityValue = "never_on" // Displayed as "Always Off" in the UI
)

type EditAnExistingResourceGroupOptions added in v0.116.0 

type EditAnExistingResourceGroupOptions struct {
	ProcessMode *ResourceGroupProcessMode `url:"process_mode,omitempty" json:"process_mode,omitempty"`
}

EditAnExistingResourceGroupOptions represents the available EditAnExistingResourceGroup options.

GitLab API docs: https://docs.gitlab.com/api/resource_groups/#edit-an-existing-resource-group

type EditClusterOptions added in v0.116.0 

type EditClusterOptions struct {
	Name                *string                        `url:"name,omitempty" json:"name,omitempty"`
	Domain              *string                        `url:"domain,omitempty" json:"domain,omitempty"`
	EnvironmentScope    *string                        `url:"environment_scope,omitempty" json:"environment_scope,omitempty"`
	ManagementProjectID *string                        `url:"management_project_id,omitempty" json:"management_project_id,omitempty"`
	PlatformKubernetes  *EditPlatformKubernetesOptions `url:"platform_kubernetes_attributes,omitempty" json:"platform_kubernetes_attributes,omitempty"`
}

EditClusterOptions represents the available EditCluster() options. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/project_clusters/#edit-project-cluster

type EditEnvironmentOptions added in v0.7.0 

type EditEnvironmentOptions struct {
	Name                *string `url:"name,omitempty" json:"name,omitempty"`
	Description         *string `url:"description,omitempty" json:"description,omitempty"`
	ExternalURL         *string `url:"external_url,omitempty" json:"external_url,omitempty"`
	Tier                *string `url:"tier,omitempty" json:"tier,omitempty"`
	ClusterAgentID      *int64  `url:"cluster_agent_id,omitempty" json:"cluster_agent_id,omitempty"`
	KubernetesNamespace *string `url:"kubernetes_namespace,omitempty" json:"kubernetes_namespace,omitempty"`
	FluxResourcePath    *string `url:"flux_resource_path,omitempty" json:"flux_resource_path,omitempty"`
	AutoStopSetting     *string `url:"auto_stop_setting,omitempty" json:"auto_stop_setting,omitempty"`
}

EditEnvironmentOptions represents the available EditEnvironment() options.

GitLab API docs: https://docs.gitlab.com/api/environments/#update-an-existing-environment

type EditGeoSiteOptions added in v0.128.0 

type EditGeoSiteOptions struct {
	Enabled                          *bool     `url:"enabled,omitempty" json:"enabled,omitempty"`
	Name                             *string   `url:"name,omitempty" json:"name,omitempty"`
	URL                              *string   `url:"url,omitempty" json:"url,omitempty"`
	InternalURL                      *string   `url:"internal_url,omitempty" json:"internal_url,omitempty"`
	FilesMaxCapacity                 *int64    `url:"files_max_capacity,omitempty" json:"files_max_capacity,omitempty"`
	ReposMaxCapacity                 *int64    `url:"repos_max_capacity,omitempty" json:"repos_max_capacity,omitempty"`
	VerificationMaxCapacity          *int64    `url:"verification_max_capacity,omitempty" json:"verification_max_capacity,omitempty"`
	ContainerRepositoriesMaxCapacity *int64    `url:"container_repositories_max_capacity,omitempty" json:"container_repositories_max_capacity,omitempty"`
	SelectiveSyncType                *string   `url:"selective_sync_type,omitempty" json:"selective_sync_type,omitempty"`
	SelectiveSyncShards              *[]string `url:"selective_sync_shards,omitempty" json:"selective_sync_shards,omitempty"`
	SelectiveSyncNamespaceIDs        *[]int64  `url:"selective_sync_namespace_ids,omitempty" json:"selective_sync_namespace_ids,omitempty"`
	MinimumReverificationInterval    *int64    `url:"minimum_reverification_interval,omitempty" json:"minimum_reverification_interval,omitempty"`
}

EditGeoSiteOptions represents the available EditGeoSite() options.

GitLab API docs: https://docs.gitlab.com/api/geo_sites/#update-a-geo-site

type EditGroupBadgeOptions added in v0.116.0 

type EditGroupBadgeOptions struct {
	LinkURL  *string `url:"link_url,omitempty" json:"link_url,omitempty"`
	ImageURL *string `url:"image_url,omitempty" json:"image_url,omitempty"`
	Name     *string `url:"name,omitempty" json:"name,omitempty"`
}

EditGroupBadgeOptions represents the available EditGroupBadge() options.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#edit-a-badge-of-a-group

type EditGroupClusterOptions added in v0.116.0 

type EditGroupClusterOptions struct {
	Name                *string                             `url:"name,omitempty" json:"name,omitempty"`
	Domain              *string                             `url:"domain,omitempty" json:"domain,omitempty"`
	EnvironmentScope    *string                             `url:"environment_scope,omitempty" json:"environment_scope,omitempty"`
	PlatformKubernetes  *EditGroupPlatformKubernetesOptions `url:"platform_kubernetes_attributes,omitempty" json:"platform_kubernetes_attributes,omitempty"`
	ManagementProjectID *string                             `url:"management_project_id,omitempty" json:"management_project_id,omitempty"`
}

EditGroupClusterOptions represents the available EditCluster() options. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/group_clusters/#edit-group-cluster

type EditGroupHookOptions added in v0.116.0 

type EditGroupHookOptions struct {
	URL                                   *string              `url:"url,omitempty" json:"url,omitempty"`
	Name                                  *string              `url:"name,omitempty" json:"name,omitempty"`
	Description                           *string              `url:"description,omitempty" json:"description,omitempty"`
	PushEvents                            *bool                `url:"push_events,omitempty" json:"push_events,omitempty"`
	PushEventsBranchFilter                *string              `url:"push_events_branch_filter,omitempty"  json:"push_events_branch_filter,omitempty"`
	BranchFilterStrategy                  *string              `url:"branch_filter_strategy,omitempty"  json:"branch_filter_strategy,omitempty"`
	IssuesEvents                          *bool                `url:"issues_events,omitempty" json:"issues_events,omitempty"`
	ConfidentialIssuesEvents              *bool                `url:"confidential_issues_events,omitempty" json:"confidential_issues_events,omitempty"`
	MergeRequestsEvents                   *bool                `url:"merge_requests_events,omitempty" json:"merge_requests_events,omitempty"`
	TagPushEvents                         *bool                `url:"tag_push_events,omitempty" json:"tag_push_events,omitempty"`
	NoteEvents                            *bool                `url:"note_events,omitempty" json:"note_events,omitempty"`
	ConfidentialNoteEvents                *bool                `url:"confidential_note_events,omitempty" json:"confidential_note_events,omitempty"`
	JobEvents                             *bool                `url:"job_events,omitempty" json:"job_events,omitempty"`
	PipelineEvents                        *bool                `url:"pipeline_events,omitempty" json:"pipeline_events,omitempty"`
	ProjectEvents                         *bool                `url:"project_events,omitempty" json:"project_events,omitempty"`
	WikiPageEvents                        *bool                `url:"wiki_page_events,omitempty" json:"wiki_page_events,omitempty"`
	DeploymentEvents                      *bool                `url:"deployment_events,omitempty" json:"deployment_events,omitempty"`
	FeatureFlagEvents                     *bool                `url:"feature_flag_events,omitempty" json:"feature_flag_events,omitempty"`
	ReleasesEvents                        *bool                `url:"releases_events,omitempty" json:"releases_events,omitempty"`
	MilestoneEvents                       *bool                `url:"milestone_events,omitempty" json:"milestone_events,omitempty"`
	SubGroupEvents                        *bool                `url:"subgroup_events,omitempty" json:"subgroup_events,omitempty"`
	EmojiEvents                           *bool                `url:"emoji_events,omitempty" json:"emoji_events,omitempty"`
	MemberEvents                          *bool                `url:"member_events,omitempty" json:"member_events,omitempty"`
	VulnerabilityEvents                   *bool                `url:"vulnerability_events,omitempty" json:"vulnerability_events,omitempty"`
	EnableSSLVerification                 *bool                `url:"enable_ssl_verification,omitempty" json:"enable_ssl_verification,omitempty"`
	ServiceAccessTokensExpirationEnforced *bool                `url:"service_access_tokens_expiration_enforced,omitempty" json:"service_access_tokens_expiration_enforced,omitempty"`
	Token                                 *string              `url:"token,omitempty" json:"token,omitempty"`
	ResourceAccessTokenEvents             *bool                `url:"resource_access_token_events,omitempty" json:"resource_access_token_events,omitempty"`
	CustomWebhookTemplate                 *string              `url:"custom_webhook_template,omitempty" json:"custom_webhook_template,omitempty"`
	CustomHeaders                         *[]*HookCustomHeader `url:"custom_headers,omitempty" json:"custom_headers,omitempty"`
}

EditGroupHookOptions represents the available EditGroupHook() options.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#edit-group-hook

type EditGroupMemberOptions added in v0.6.2 

type EditGroupMemberOptions struct {
	AccessLevel  *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	ExpiresAt    *string           `url:"expires_at,omitempty" json:"expires_at,omitempty"`
	MemberRoleID *int64            `url:"member_role_id,omitempty" json:"member_role_id,omitempty"`
}

EditGroupMemberOptions represents the available EditGroupMember() options.

GitLab API docs: https://docs.gitlab.com/api/members/#edit-a-member-of-a-group-or-project

type EditGroupPlatformKubernetesOptions added in v0.116.0 

type EditGroupPlatformKubernetesOptions struct {
	APIURL *string `url:"api_url,omitempty" json:"api_url,omitempty"`
	Token  *string `url:"token,omitempty" json:"token,omitempty"`
	CaCert *string `url:"ca_cert,omitempty" json:"ca_cert,omitempty"`
}

EditGroupPlatformKubernetesOptions represents the available PlatformKubernetes options for editing. Deprecated: in GitLab 14.5, to be removed in 19.0

type EditGroupPushRuleOptions added in v0.116.0 

type EditGroupPushRuleOptions struct {
	AuthorEmailRegex           *string `url:"author_email_regex,omitempty" json:"author_email_regex,omitempty"`
	BranchNameRegex            *string `url:"branch_name_regex,omitempty" json:"branch_name_regex,omitempty"`
	CommitCommitterCheck       *bool   `url:"commit_committer_check,omitempty" json:"commit_committer_check,omitempty"`
	CommitCommitterNameCheck   *bool   `url:"commit_committer_name_check,omitempty" json:"commit_committer_name_check,omitempty"`
	CommitMessageNegativeRegex *string `url:"commit_message_negative_regex,omitempty" json:"commit_message_negative_regex,omitempty"`
	CommitMessageRegex         *string `url:"commit_message_regex,omitempty" json:"commit_message_regex,omitempty"`
	DenyDeleteTag              *bool   `url:"deny_delete_tag,omitempty" json:"deny_delete_tag,omitempty"`
	FileNameRegex              *string `url:"file_name_regex,omitempty" json:"file_name_regex,omitempty"`
	MaxFileSize                *int64  `url:"max_file_size,omitempty" json:"max_file_size,omitempty"`
	MemberCheck                *bool   `url:"member_check,omitempty" json:"member_check,omitempty"`
	PreventSecrets             *bool   `url:"prevent_secrets,omitempty" json:"prevent_secrets,omitempty"`
	RejectUnsignedCommits      *bool   `url:"reject_unsigned_commits,omitempty" json:"reject_unsigned_commits,omitempty"`
	RejectNonDCOCommits        *bool   `url:"reject_non_dco_commits,omitempty" json:"reject_non_dco_commits,omitempty"`
}

EditGroupPushRuleOptions represents the available EditGroupPushRule() options.

GitLab API docs: https://docs.gitlab.com/api/group_push_rules/#edit-the-push-rules-of-a-group

type EditGroupWikiPageOptions added in v0.116.0 

type EditGroupWikiPageOptions struct {
	Content *string          `url:"content,omitempty" json:"content,omitempty"`
	Title   *string          `url:"title,omitempty" json:"title,omitempty"`
	Format  *WikiFormatValue `url:"format,omitempty" json:"format,omitempty"`
}

EditGroupWikiPageOptions represents options to EditGroupWikiPage.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/#edit-an-existing-wiki-page

type EditPipelineScheduleOptions added in v0.9.0 

type EditPipelineScheduleOptions struct {
	Description  *string          `url:"description,omitempty" json:"description,omitempty"`
	Ref          *string          `url:"ref,omitempty" json:"ref,omitempty"`
	Cron         *string          `url:"cron,omitempty" json:"cron,omitempty"`
	CronTimezone *string          `url:"cron_timezone,omitempty" json:"cron_timezone,omitempty"`
	Active       *bool            `url:"active,omitempty" json:"active,omitempty"`
	Inputs       []*PipelineInput `url:"inputs,omitempty" json:"inputs,omitempty"`
}

EditPipelineScheduleOptions represents the available EditPipelineSchedule() options.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#edit-a-pipeline-schedule

type EditPipelineScheduleVariableOptions added in v0.9.0 

type EditPipelineScheduleVariableOptions struct {
	Value        *string            `url:"value" json:"value"`
	VariableType *VariableTypeValue `url:"variable_type,omitempty" json:"variable_type,omitempty"`
}

EditPipelineScheduleVariableOptions represents the available EditPipelineScheduleVariable() options.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#edit-a-pipeline-schedule-variable

type EditPipelineTriggerOptions added in v0.6.0 

type EditPipelineTriggerOptions struct {
	Description *string `url:"description,omitempty" json:"description,omitempty"`
}

EditPipelineTriggerOptions represents the available EditPipelineTrigger() options.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/#update-a-pipeline-trigger-token

type EditPlatformKubernetesOptions added in v0.116.0 

type EditPlatformKubernetesOptions struct {
	APIURL    *string `url:"api_url,omitempty" json:"api_url,omitempty"`
	Token     *string `url:"token,omitempty" json:"token,omitempty"`
	CaCert    *string `url:"ca_cert,omitempty" json:"ca_cert,omitempty"`
	Namespace *string `url:"namespace,omitempty" json:"namespace,omitempty"`
}

EditPlatformKubernetesOptions represents the available PlatformKubernetes options for editing. Deprecated: in GitLab 14.5, to be removed in 19.0

type EditProjectBadgeOptions added in v0.11.1 

type EditProjectBadgeOptions struct {
	LinkURL  *string `url:"link_url,omitempty" json:"link_url,omitempty"`
	ImageURL *string `url:"image_url,omitempty" json:"image_url,omitempty"`
	Name     *string `url:"name,omitempty" json:"name,omitempty"`
}

EditProjectBadgeOptions represents the available EditProjectBadge() options.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#edit-a-badge-of-a-project

type EditProjectHookOptions 

type EditProjectHookOptions struct {
	Name                      *string              `url:"name,omitempty" json:"name,omitempty"`
	Description               *string              `url:"description,omitempty" json:"description,omitempty"`
	ConfidentialIssuesEvents  *bool                `url:"confidential_issues_events,omitempty" json:"confidential_issues_events,omitempty"`
	ConfidentialNoteEvents    *bool                `url:"confidential_note_events,omitempty" json:"confidential_note_events,omitempty"`
	DeploymentEvents          *bool                `url:"deployment_events,omitempty" json:"deployment_events,omitempty"`
	EnableSSLVerification     *bool                `url:"enable_ssl_verification,omitempty" json:"enable_ssl_verification,omitempty"`
	IssuesEvents              *bool                `url:"issues_events,omitempty" json:"issues_events,omitempty"`
	JobEvents                 *bool                `url:"job_events,omitempty" json:"job_events,omitempty"`
	MergeRequestsEvents       *bool                `url:"merge_requests_events,omitempty" json:"merge_requests_events,omitempty"`
	NoteEvents                *bool                `url:"note_events,omitempty" json:"note_events,omitempty"`
	PipelineEvents            *bool                `url:"pipeline_events,omitempty" json:"pipeline_events,omitempty"`
	PushEvents                *bool                `url:"push_events,omitempty" json:"push_events,omitempty"`
	PushEventsBranchFilter    *string              `url:"push_events_branch_filter,omitempty" json:"push_events_branch_filter,omitempty"`
	ReleasesEvents            *bool                `url:"releases_events,omitempty" json:"releases_events,omitempty"`
	EmojiEvents               *bool                `url:"emoji_events,omitempty" json:"emoji_events,omitempty"`
	TagPushEvents             *bool                `url:"tag_push_events,omitempty" json:"tag_push_events,omitempty"`
	Token                     *string              `url:"token,omitempty" json:"token,omitempty"`
	URL                       *string              `url:"url,omitempty" json:"url,omitempty"`
	WikiPageEvents            *bool                `url:"wiki_page_events,omitempty" json:"wiki_page_events,omitempty"`
	ResourceAccessTokenEvents *bool                `url:"resource_access_token_events,omitempty" json:"resource_access_token_events,omitempty"`
	CustomWebhookTemplate     *string              `url:"custom_webhook_template,omitempty" json:"custom_webhook_template,omitempty"`
	CustomHeaders             *[]*HookCustomHeader `url:"custom_headers,omitempty" json:"custom_headers,omitempty"`
	VulnerabilityEvents       *bool                `url:"vulnerability_events,omitempty" json:"vulnerability_events,omitempty"`
	BranchFilterStrategy      *string              `url:"branch_filter_strategy,omitempty" json:"branch_filter_strategy,omitempty"`
}

EditProjectHookOptions represents the available EditProjectHook() options.

GitLab API docs: https://docs.gitlab.com/api/project_webhooks/#edit-a-project-webhook

type EditProjectMemberOptions 

type EditProjectMemberOptions struct {
	AccessLevel  *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	ExpiresAt    *string           `url:"expires_at,omitempty" json:"expires_at,omitempty"`
	MemberRoleID *int64            `url:"member_role_id,omitempty" json:"member_role_id,omitempty"`
}

EditProjectMemberOptions represents the available EditProjectMember() options.

GitLab API docs: https://docs.gitlab.com/api/members/#edit-a-member-of-a-group-or-project

type EditProjectMirrorOptions added in v0.116.0 

type EditProjectMirrorOptions struct {
	Enabled               *bool   `url:"enabled,omitempty" json:"enabled,omitempty"`
	KeepDivergentRefs     *bool   `url:"keep_divergent_refs,omitempty" json:"keep_divergent_refs,omitempty"`
	OnlyProtectedBranches *bool   `url:"only_protected_branches,omitempty" json:"only_protected_branches,omitempty"`
	MirrorBranchRegex     *string `url:"mirror_branch_regex,omitempty" json:"mirror_branch_regex,omitempty"`
	AuthMethod            *string `url:"auth_method,omitempty" json:"auth_method,omitempty"`
}

EditProjectMirrorOptions contains the properties requires to edit an existing project mirror.

GitLab API docs: https://docs.gitlab.com/api/remote_mirrors/#update-a-remote-mirrors-attributes

type EditProjectOptions 

type EditProjectOptions struct {
	AllowMergeOnSkippedPipeline               *bool                                        `url:"allow_merge_on_skipped_pipeline,omitempty" json:"allow_merge_on_skipped_pipeline,omitempty"`
	AllowPipelineTriggerApproveDeployment     *bool                                        `url:"allow_pipeline_trigger_approve_deployment,omitempty" json:"allow_pipeline_trigger_approve_deployment,omitempty"`
	OnlyAllowMergeIfAllStatusChecksPassed     *bool                                        `url:"only_allow_merge_if_all_status_checks_passed,omitempty" json:"only_allow_merge_if_all_status_checks_passed,omitempty"`
	AnalyticsAccessLevel                      *AccessControlValue                          `url:"analytics_access_level,omitempty" json:"analytics_access_level,omitempty"`
	AutoCancelPendingPipelines                *string                                      `url:"auto_cancel_pending_pipelines,omitempty" json:"auto_cancel_pending_pipelines,omitempty"`
	AutoDevopsDeployStrategy                  *string                                      `url:"auto_devops_deploy_strategy,omitempty" json:"auto_devops_deploy_strategy,omitempty"`
	AutoDevopsEnabled                         *bool                                        `url:"auto_devops_enabled,omitempty" json:"auto_devops_enabled,omitempty"`
	AutoDuoCodeReviewEnabled                  *bool                                        `url:"auto_duo_code_review_enabled,omitempty" json:"auto_duo_code_review_enabled,omitempty"`
	AutocloseReferencedIssues                 *bool                                        `url:"autoclose_referenced_issues,omitempty" json:"autoclose_referenced_issues,omitempty"`
	Avatar                                    *ProjectAvatar                               `url:"-" json:"avatar,omitempty"`
	BuildCoverageRegex                        *string                                      `url:"build_coverage_regex,omitempty" json:"build_coverage_regex,omitempty"`
	BuildGitStrategy                          *string                                      `url:"build_git_strategy,omitempty" json:"build_git_strategy,omitempty"`
	BuildTimeout                              *int64                                       `url:"build_timeout,omitempty" json:"build_timeout,omitempty"`
	BuildsAccessLevel                         *AccessControlValue                          `url:"builds_access_level,omitempty" json:"builds_access_level,omitempty"`
	CIConfigPath                              *string                                      `url:"ci_config_path,omitempty" json:"ci_config_path,omitempty"`
	CIDefaultGitDepth                         *int64                                       `url:"ci_default_git_depth,omitempty" json:"ci_default_git_depth,omitempty"`
	CIDeletePipelinesInSeconds                *int64                                       `url:"ci_delete_pipelines_in_seconds,omitempty" json:"ci_delete_pipelines_in_seconds,omitempty"`
	CIForwardDeploymentEnabled                *bool                                        `url:"ci_forward_deployment_enabled,omitempty" json:"ci_forward_deployment_enabled,omitempty"`
	CIForwardDeploymentRollbackAllowed        *bool                                        `url:"ci_forward_deployment_rollback_allowed,omitempty" json:"ci_forward_deployment_rollback_allowed,omitempty"`
	CIPushRepositoryForJobTokenAllowed        *bool                                        `url:"ci_push_repository_for_job_token_allowed,omitempty" json:"ci_push_repository_for_job_token_allowed,omitempty"`
	CIIdTokenSubClaimComponents               *[]string                                    `url:"ci_id_token_sub_claim_components,omitempty" json:"ci_id_token_sub_claim_components,omitempty"`
	CISeparatedCaches                         *bool                                        `url:"ci_separated_caches,omitempty" json:"ci_separated_caches,omitempty"`
	CIRestrictPipelineCancellationRole        *AccessControlValue                          `url:"ci_restrict_pipeline_cancellation_role,omitempty" json:"ci_restrict_pipeline_cancellation_role,omitempty"`
	CIPipelineVariablesMinimumOverrideRole    *CIPipelineVariablesMinimumOverrideRoleValue `url:"ci_pipeline_variables_minimum_override_role,omitempty" json:"ci_pipeline_variables_minimum_override_role,omitempty"`
	ContainerExpirationPolicyAttributes       *ContainerExpirationPolicyAttributes         `url:"container_expiration_policy_attributes,omitempty" json:"container_expiration_policy_attributes,omitempty"`
	ContainerRegistryAccessLevel              *AccessControlValue                          `url:"container_registry_access_level,omitempty" json:"container_registry_access_level,omitempty"`
	DefaultBranch                             *string                                      `url:"default_branch,omitempty" json:"default_branch,omitempty"`
	Description                               *string                                      `url:"description,omitempty" json:"description,omitempty"`
	EmailsEnabled                             *bool                                        `url:"emails_enabled,omitempty" json:"emails_enabled,omitempty"`
	EnforceAuthChecksOnUploads                *bool                                        `url:"enforce_auth_checks_on_uploads,omitempty" json:"enforce_auth_checks_on_uploads,omitempty"`
	ExternalAuthorizationClassificationLabel  *string                                      `url:"external_authorization_classification_label,omitempty" json:"external_authorization_classification_label,omitempty"`
	ForkingAccessLevel                        *AccessControlValue                          `url:"forking_access_level,omitempty" json:"forking_access_level,omitempty"`
	ImportURL                                 *string                                      `url:"import_url,omitempty" json:"import_url,omitempty"`
	IssuesAccessLevel                         *AccessControlValue                          `url:"issues_access_level,omitempty" json:"issues_access_level,omitempty"`
	IssueBranchTemplate                       *string                                      `url:"issue_branch_template,omitempty" json:"issue_branch_template,omitempty"`
	IssuesTemplate                            *string                                      `url:"issues_template,omitempty" json:"issues_template,omitempty"`
	KeepLatestArtifact                        *bool                                        `url:"keep_latest_artifact,omitempty" json:"keep_latest_artifact,omitempty"`
	LFSEnabled                                *bool                                        `url:"lfs_enabled,omitempty" json:"lfs_enabled,omitempty"`
	MaxArtifactsSize                          *int64                                       `url:"max_artifacts_size,omitempty" json:"max_artifacts_size,omitempty"`
	MergeCommitTemplate                       *string                                      `url:"merge_commit_template,omitempty" json:"merge_commit_template,omitempty"`
	MergeRequestDefaultTargetSelf             *bool                                        `url:"mr_default_target_self,omitempty" json:"mr_default_target_self,omitempty"`
	MergeMethod                               *MergeMethodValue                            `url:"merge_method,omitempty" json:"merge_method,omitempty"`
	MergePipelinesEnabled                     *bool                                        `url:"merge_pipelines_enabled,omitempty" json:"merge_pipelines_enabled,omitempty"`
	MergeRequestsAccessLevel                  *AccessControlValue                          `url:"merge_requests_access_level,omitempty" json:"merge_requests_access_level,omitempty"`
	MergeRequestsTemplate                     *string                                      `url:"merge_requests_template,omitempty" json:"merge_requests_template,omitempty"`
	MergeTrainsEnabled                        *bool                                        `url:"merge_trains_enabled,omitempty" json:"merge_trains_enabled,omitempty"`
	MergeTrainsSkipTrainAllowed               *bool                                        `url:"merge_trains_skip_train_allowed,omitempty" json:"merge_trains_skip_train_allowed,omitempty"`
	Mirror                                    *bool                                        `url:"mirror,omitempty" json:"mirror,omitempty"`
	MirrorBranchRegex                         *string                                      `url:"mirror_branch_regex,omitempty" json:"mirror_branch_regex,omitempty"`
	MirrorOverwritesDivergedBranches          *bool                                        `url:"mirror_overwrites_diverged_branches,omitempty" json:"mirror_overwrites_diverged_branches,omitempty"`
	MirrorTriggerBuilds                       *bool                                        `url:"mirror_trigger_builds,omitempty" json:"mirror_trigger_builds,omitempty"`
	MirrorUserID                              *int64                                       `url:"mirror_user_id,omitempty" json:"mirror_user_id,omitempty"`
	ModelExperimentsAccessLevel               *AccessControlValue                          `url:"model_experiments_access_level,omitempty" json:"model_experiments_access_level,omitempty"`
	ModelRegistryAccessLevel                  *AccessControlValue                          `url:"model_registry_access_level,omitempty" json:"model_registry_access_level,omitempty"`
	Name                                      *string                                      `url:"name,omitempty" json:"name,omitempty"`
	OnlyAllowMergeIfAllDiscussionsAreResolved *bool                                        `` /* 130-byte string literal not displayed */
	OnlyAllowMergeIfPipelineSucceeds          *bool                                        `url:"only_allow_merge_if_pipeline_succeeds,omitempty" json:"only_allow_merge_if_pipeline_succeeds,omitempty"`
	OnlyMirrorProtectedBranches               *bool                                        `url:"only_mirror_protected_branches,omitempty" json:"only_mirror_protected_branches,omitempty"`
	OperationsAccessLevel                     *AccessControlValue                          `url:"operations_access_level,omitempty" json:"operations_access_level,omitempty"`
	PackagesEnabled                           *bool                                        `url:"packages_enabled,omitempty" json:"packages_enabled,omitempty"`
	PagesAccessLevel                          *AccessControlValue                          `url:"pages_access_level,omitempty" json:"pages_access_level,omitempty"`
	Path                                      *string                                      `url:"path,omitempty" json:"path,omitempty"`
	PublicJobs                                *bool                                        `url:"public_jobs,omitempty" json:"public_jobs,omitempty"`
	ReleasesAccessLevel                       *AccessControlValue                          `url:"releases_access_level,omitempty" json:"releases_access_level,omitempty"`
	EnvironmentsAccessLevel                   *AccessControlValue                          `url:"environments_access_level,omitempty" json:"environments_access_level,omitempty"`
	FeatureFlagsAccessLevel                   *AccessControlValue                          `url:"feature_flags_access_level,omitempty" json:"feature_flags_access_level,omitempty"`
	InfrastructureAccessLevel                 *AccessControlValue                          `url:"infrastructure_access_level,omitempty" json:"infrastructure_access_level,omitempty"`
	MonitorAccessLevel                        *AccessControlValue                          `url:"monitor_access_level,omitempty" json:"monitor_access_level,omitempty"`
	RemoveSourceBranchAfterMerge              *bool                                        `url:"remove_source_branch_after_merge,omitempty" json:"remove_source_branch_after_merge,omitempty"`
	PreventMergeWithoutJiraIssue              *bool                                        `url:"prevent_merge_without_jira_issue,omitempty" json:"prevent_merge_without_jira_issue,omitempty"`
	PrintingMergeRequestLinkEnabled           *bool                                        `url:"printing_merge_request_link_enabled,omitempty" json:"printing_merge_request_link_enabled,omitempty"`
	RepositoryAccessLevel                     *AccessControlValue                          `url:"repository_access_level,omitempty" json:"repository_access_level,omitempty"`
	RepositoryStorage                         *string                                      `url:"repository_storage,omitempty" json:"repository_storage,omitempty"`
	RequestAccessEnabled                      *bool                                        `url:"request_access_enabled,omitempty" json:"request_access_enabled,omitempty"`
	RequirementsAccessLevel                   *AccessControlValue                          `url:"requirements_access_level,omitempty" json:"requirements_access_level,omitempty"`
	ResolveOutdatedDiffDiscussions            *bool                                        `url:"resolve_outdated_diff_discussions,omitempty" json:"resolve_outdated_diff_discussions,omitempty"`
	SecurityAndComplianceAccessLevel          *AccessControlValue                          `url:"security_and_compliance_access_level,omitempty" json:"security_and_compliance_access_level,omitempty"`
	ServiceDeskEnabled                        *bool                                        `url:"service_desk_enabled,omitempty" json:"service_desk_enabled,omitempty"`
	SharedRunnersEnabled                      *bool                                        `url:"shared_runners_enabled,omitempty" json:"shared_runners_enabled,omitempty"`
	GroupRunnersEnabled                       *bool                                        `url:"group_runners_enabled,omitempty" json:"group_runners_enabled,omitempty"`
	ResourceGroupDefaultProcessMode           *ResourceGroupProcessMode                    `url:"resource_group_default_process_mode,omitempty" json:"resource_group_default_process_mode,omitempty"`
	ShowDefaultAwardEmojis                    *bool                                        `url:"show_default_award_emojis,omitempty" json:"show_default_award_emojis,omitempty"`
	SnippetsAccessLevel                       *AccessControlValue                          `url:"snippets_access_level,omitempty" json:"snippets_access_level,omitempty"`
	SquashCommitTemplate                      *string                                      `url:"squash_commit_template,omitempty" json:"squash_commit_template,omitempty"`
	SquashOption                              *SquashOptionValue                           `url:"squash_option,omitempty" json:"squash_option,omitempty"`
	SuggestionCommitMessage                   *string                                      `url:"suggestion_commit_message,omitempty" json:"suggestion_commit_message,omitempty"`
	Topics                                    *[]string                                    `url:"topics,omitempty" json:"topics,omitempty"`
	Visibility                                *VisibilityValue                             `url:"visibility,omitempty" json:"visibility,omitempty"`
	WikiAccessLevel                           *AccessControlValue                          `url:"wiki_access_level,omitempty" json:"wiki_access_level,omitempty"`

	// Deprecated: use Merge Request Approvals API instead
	ApprovalsBeforeMerge *int64 `url:"approvals_before_merge,omitempty" json:"approvals_before_merge,omitempty"`
	// Deprecated: use PublicJobs instead
	PublicBuilds *bool `url:"public_builds,omitempty" json:"public_builds,omitempty"`
	// Deprecated: use CIPipelineVariablesMinimumOverrideRole instead
	RestrictUserDefinedVariables *bool `url:"restrict_user_defined_variables,omitempty" json:"restrict_user_defined_variables,omitempty"`
	// Deprecated: Use ContainerRegistryAccessLevel instead.
	ContainerRegistryEnabled *bool `url:"container_registry_enabled,omitempty" json:"container_registry_enabled,omitempty"`
	// Deprecated: Use EmailsEnabled instead
	EmailsDisabled *bool `url:"emails_disabled,omitempty" json:"emails_disabled,omitempty"`
	// Deprecated: Use IssuesAccessLevel instead.
	IssuesEnabled *bool `url:"issues_enabled,omitempty" json:"issues_enabled,omitempty"`
	// Deprecated: Use BuildsAccessLevel instead.
	JobsEnabled *bool `url:"jobs_enabled,omitempty" json:"jobs_enabled,omitempty"`
	// Deprecated: Use MergeRequestsAccessLevel instead.
	MergeRequestsEnabled *bool `url:"merge_requests_enabled,omitempty" json:"merge_requests_enabled,omitempty"`
	// Deprecated: Use SnippetsAccessLevel instead.
	SnippetsEnabled *bool `url:"snippets_enabled,omitempty" json:"snippets_enabled,omitempty"`
	// Deprecated: Use Topics instead. (Deprecated in GitLab 14.0)
	TagList *[]string `url:"tag_list,omitempty" json:"tag_list,omitempty"`
	// Deprecated: Use WikiAccessLevel instead.
	WikiEnabled *bool `url:"wiki_enabled,omitempty" json:"wiki_enabled,omitempty"`
}

EditProjectOptions represents the available EditProject() options.

GitLab API docs: https://docs.gitlab.com/api/projects/#edit-a-project

type EditProjectPushRuleOptions added in v0.116.0 

type EditProjectPushRuleOptions struct {
	AuthorEmailRegex           *string `url:"author_email_regex,omitempty" json:"author_email_regex,omitempty"`
	BranchNameRegex            *string `url:"branch_name_regex,omitempty" json:"branch_name_regex,omitempty"`
	CommitCommitterCheck       *bool   `url:"commit_committer_check,omitempty" json:"commit_committer_check,omitempty"`
	CommitCommitterNameCheck   *bool   `url:"commit_committer_name_check,omitempty" json:"commit_committer_name_check,omitempty"`
	CommitMessageNegativeRegex *string `url:"commit_message_negative_regex,omitempty" json:"commit_message_negative_regex,omitempty"`
	CommitMessageRegex         *string `url:"commit_message_regex,omitempty" json:"commit_message_regex,omitempty"`
	DenyDeleteTag              *bool   `url:"deny_delete_tag,omitempty" json:"deny_delete_tag,omitempty"`
	FileNameRegex              *string `url:"file_name_regex,omitempty" json:"file_name_regex,omitempty"`
	MaxFileSize                *int64  `url:"max_file_size,omitempty" json:"max_file_size,omitempty"`
	MemberCheck                *bool   `url:"member_check,omitempty" json:"member_check,omitempty"`
	PreventSecrets             *bool   `url:"prevent_secrets,omitempty" json:"prevent_secrets,omitempty"`
	RejectUnsignedCommits      *bool   `url:"reject_unsigned_commits,omitempty" json:"reject_unsigned_commits,omitempty"`
	RejectNonDCOCommits        *bool   `url:"reject_non_dco_commits,omitempty" json:"reject_non_dco_commits,omitempty"`
}

EditProjectPushRuleOptions represents the available EditProjectPushRule() options.

GitLab API docs: https://docs.gitlab.com/api/project_push_rules/#edit-project-push-rule

type EditWikiPageOptions added in v0.7.0 

type EditWikiPageOptions struct {
	Content *string          `url:"content,omitempty" json:"content,omitempty"`
	Title   *string          `url:"title,omitempty" json:"title,omitempty"`
	Format  *WikiFormatValue `url:"format,omitempty" json:"format,omitempty"`
}

EditWikiPageOptions represents options to EditWikiPage.

GitLab API docs: https://docs.gitlab.com/api/wikis/#edit-an-existing-wiki-page

type Email added in v0.4.0 

type Email struct {
	ID          int64      `json:"id"`
	Email       string     `json:"email"`
	ConfirmedAt *time.Time `json:"confirmed_at"`
}

Email represents an Email.

GitLab API docs: https://docs.gitlab.com/api/user_email_addresses/#list-all-email-addresses

type EmailsOnPushService added in v0.116.0 

type EmailsOnPushService struct {
	Service
	Properties *EmailsOnPushServiceProperties `json:"properties"`
}

EmailsOnPushService represents Emails on Push service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#emails-on-push

type EmailsOnPushServiceProperties added in v0.116.0 

type EmailsOnPushServiceProperties struct {
	Recipients             string `json:"recipients"`
	DisableDiffs           bool   `json:"disable_diffs"`
	SendFromCommitterEmail bool   `json:"send_from_committer_email"`
	BranchesToBeNotified   string `json:"branches_to_be_notified"`

	// Deprecated: to be removed in 2.0 - use EmailsOnPushService.PushEvents instead.
	PushEvents bool `json:"push_events"`
	// Deprecated: to be removed in 2.0 - use EmailsOnPushService.TagPushEvents instead.
	TagPushEvents bool `json:"tag_push_events"`
}

EmailsOnPushServiceProperties represents Emails on Push specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#emails-on-push

type EmojiEvent added in v1.20.0 

type EmojiEvent struct {
	ObjectKind       string                     `json:"object_kind"`
	EventType        string                     `json:"event_type"`
	User             EventUser                  `json:"user"`
	ProjectID        int64                      `json:"project_id"`
	Project          EmojiEventProject          `json:"project"`
	ObjectAttributes EmojiEventObjectAttributes `json:"object_attributes"`
	Note             *EmojiEventNote            `json:"note,omitempty"`
	Issue            *EmojiEventIssue           `json:"issue,omitempty"`
	MergeRequest     *EmojiEventMergeRequest    `json:"merge_request,omitempty"`
	ProjectSnippet   *EmojiEventSnippet         `json:"project_snippet,omitempty"`
	Commit           *EmojiEventCommit          `json:"commit,omitempty"`
}

EmojiEvent represents an emoji event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#emoji-events

type EmojiEventCommit added in v1.31.0 

type EmojiEventCommit struct {
	ID        string            `json:"id"`
	Title     string            `json:"title"`
	Message   string            `json:"message"`
	Timestamp *time.Time        `json:"timestamp"`
	URL       string            `json:"url"`
	Author    EventCommitAuthor `json:"author"`
}

EmojiEventCommit represents a commit in an emoji event.

type EmojiEventIssue added in v1.20.0 

type EmojiEventIssue struct {
	ID                  int64         `json:"id"`
	IID                 int64         `json:"iid"`
	ProjectID           int64         `json:"project_id"`
	AuthorID            int64         `json:"author_id"`
	ClosedAt            *string       `json:"closed_at"`
	Confidential        bool          `json:"confidential"`
	CreatedAt           string        `json:"created_at"`
	Description         string        `json:"description"`
	DiscussionLocked    *bool         `json:"discussion_locked"`
	DueDate             *ISOTime      `json:"due_date"`
	LastEditedAt        *string       `json:"last_edited_at"`
	LastEditedByID      *int64        `json:"last_edited_by_id"`
	MilestoneID         *int64        `json:"milestone_id"`
	MovedToID           *int64        `json:"moved_to_id"`
	DuplicatedToID      *int64        `json:"duplicated_to_id"`
	RelativePosition    int64         `json:"relative_position"`
	StateID             StateID       `json:"state_id"`
	TimeEstimate        int64         `json:"time_estimate"`
	Title               string        `json:"title"`
	UpdatedAt           string        `json:"updated_at"`
	UpdatedByID         *int64        `json:"updated_by_id"`
	Weight              *int64        `json:"weight"`
	HealthStatus        *string       `json:"health_status"`
	URL                 string        `json:"url"`
	TotalTimeSpent      int64         `json:"total_time_spent"`
	TimeChange          int64         `json:"time_change"`
	HumanTotalTimeSpent *string       `json:"human_total_time_spent"`
	HumanTimeChange     *string       `json:"human_time_change"`
	HumanTimeEstimate   *string       `json:"human_time_estimate"`
	AssigneeIDs         []int64       `json:"assignee_ids"`
	AssigneeID          *int64        `json:"assignee_id"`
	Labels              []*EventLabel `json:"labels"`
	State               string        `json:"state"`
	Severity            string        `json:"severity"`
}

type EmojiEventMergeRequest added in v1.31.0 

type EmojiEventMergeRequest struct {
	ID                        int64                       `json:"id"`
	TargetBranch              string                      `json:"target_branch"`
	SourceBranch              string                      `json:"source_branch"`
	SourceProjectID           int64                       `json:"source_project_id"`
	AuthorID                  int64                       `json:"author_id"`
	AssigneeID                int64                       `json:"assignee_id"`
	AssigneeIDs               []int64                     `json:"assignee_ids"`
	ReviewerIDs               []int64                     `json:"reviewer_ids"`
	Title                     string                      `json:"title"`
	CreatedAt                 string                      `json:"created_at"`
	UpdatedAt                 string                      `json:"updated_at"`
	MilestoneID               int64                       `json:"milestone_id"`
	State                     string                      `json:"state"`
	MergeStatus               string                      `json:"merge_status"`
	TargetProjectID           int64                       `json:"target_project_id"`
	IID                       int64                       `json:"iid"`
	Description               string                      `json:"description"`
	Position                  int64                       `json:"position"`
	Labels                    []*EventLabel               `json:"labels"`
	LockedAt                  string                      `json:"locked_at"`
	UpdatedByID               int64                       `json:"updated_by_id"`
	MergeError                string                      `json:"merge_error"`
	MergeParams               *MergeParams                `json:"merge_params"`
	MergeWhenPipelineSucceeds bool                        `json:"merge_when_pipeline_succeeds"`
	MergeUserID               int64                       `json:"merge_user_id"`
	MergeCommitSHA            string                      `json:"merge_commit_sha"`
	DeletedAt                 string                      `json:"deleted_at"`
	InProgressMergeCommitSHA  string                      `json:"in_progress_merge_commit_sha"`
	LockVersion               int64                       `json:"lock_version"`
	ApprovalsBeforeMerge      string                      `json:"approvals_before_merge"`
	RebaseCommitSHA           string                      `json:"rebase_commit_sha"`
	TimeEstimate              int64                       `json:"time_estimate"`
	Squash                    bool                        `json:"squash"`
	LastEditedAt              string                      `json:"last_edited_at"`
	LastEditedByID            int64                       `json:"last_edited_by_id"`
	Source                    *Repository                 `json:"source"`
	Target                    *Repository                 `json:"target"`
	LastCommit                EventMergeRequestLastCommit `json:"last_commit"`
	WorkInProgress            bool                        `json:"work_in_progress"`
	TotalTimeSpent            int64                       `json:"total_time_spent"`
	HeadPipelineID            int64                       `json:"head_pipeline_id"`
	Assignee                  *EventUser                  `json:"assignee"`
	DetailedMergeStatus       string                      `json:"detailed_merge_status"`
	URL                       string                      `json:"url"`
}

EmojiEventMergeRequest represents a merge request in an emoji event.

type EmojiEventNote added in v1.20.0 

type EmojiEventNote struct {
	Attachment       *string       `json:"attachment"`
	AuthorID         int64         `json:"author_id"`
	ChangePosition   *NotePosition `json:"change_position"`
	CommitID         *string       `json:"commit_id"`
	CreatedAt        string        `json:"created_at"`
	DiscussionID     string        `json:"discussion_id"`
	ID               int64         `json:"id"`
	LineCode         *string       `json:"line_code"`
	Note             string        `json:"note"`
	NoteableID       int64         `json:"noteable_id"`
	NoteableType     string        `json:"noteable_type"`
	OriginalPosition *NotePosition `json:"original_position"`
	Position         *NotePosition `json:"position"`
	ProjectID        int64         `json:"project_id"`
	ResolvedAt       *string       `json:"resolved_at"`
	ResolvedByID     *int64        `json:"resolved_by_id"`
	ResolvedByPush   *bool         `json:"resolved_by_push"`
	StDiff           *Diff         `json:"st_diff"`
	System           bool          `json:"system"`
	Type             *string       `json:"type"`
	UpdatedAt        string        `json:"updated_at"`
	UpdatedByID      *int64        `json:"updated_by_id"`
	Description      string        `json:"description"`
	URL              string        `json:"url"`
}

type EmojiEventObjectAttributes added in v1.20.0 

type EmojiEventObjectAttributes struct {
	UserID        int64  `json:"user_id"`
	CreatedAt     string `json:"created_at"`
	ID            int64  `json:"id"`
	Name          string `json:"name"`
	AwardableType string `json:"awardable_type"`
	AwardableID   int64  `json:"awardable_id"`
	UpdatedAt     string `json:"updated_at"`
	Action        string `json:"action"`
	AwardedOnURL  string `json:"awarded_on_url"`
}

type EmojiEventProject added in v1.20.0 

type EmojiEventProject struct {
	ID                int64  `json:"id"`
	Name              string `json:"name"`
	Description       string `json:"description"`
	WebURL            string `json:"web_url"`
	AvatarURL         string `json:"avatar_url"`
	GitSSHURL         string `json:"git_ssh_url"`
	GitHTTPURL        string `json:"git_http_url"`
	Namespace         string `json:"namespace"`
	VisibilityLevel   int64  `json:"visibility_level"`
	PathWithNamespace string `json:"path_with_namespace"`
	DefaultBranch     string `json:"default_branch"`
	CIConfigPath      string `json:"ci_config_path"`
	Homepage          string `json:"homepage"`
	URL               string `json:"url"`
	SSHURL            string `json:"ssh_url"`
	HTTPURL           string `json:"http_url"`
}

EmojiEventProject represents a project in an emoji event.

type EmojiEventSnippet added in v1.31.0 

type EmojiEventSnippet struct {
	ID                 int64  `json:"id"`
	Title              string `json:"title"`
	Content            string `json:"content"`
	AuthorID           int64  `json:"author_id"`
	ProjectID          int64  `json:"project_id"`
	CreatedAt          string `json:"created_at"`
	UpdatedAt          string `json:"updated_at"`
	Filename           string `json:"file_name"`
	ExpiresAt          string `json:"expires_at"`
	Type               string `json:"type"`
	VisibilityLevel    int64  `json:"visibility_level"`
	Description        string `json:"description"`
	Secret             bool   `json:"secret"`
	RepositoryReadOnly bool   `json:"repository_read_only"`
}

EmojiEventSnippet represents a snippet in an emoji event.

type EnableDisableErrorTrackingOptions added in v0.116.0 

type EnableDisableErrorTrackingOptions struct {
	Active     *bool `url:"active,omitempty" json:"active,omitempty"`
	Integrated *bool `url:"integrated,omitempty" json:"integrated,omitempty"`
}

EnableDisableErrorTrackingOptions represents the available EnableDisableErrorTracking() options.

GitLab API docs: https://docs.gitlab.com/api/error_tracking/#enable-or-disable-the-error-tracking-project-settings

type EnableProjectRunnerOptions added in v0.7.5 

type EnableProjectRunnerOptions struct {
	RunnerID int64 `json:"runner_id"`
}

EnableProjectRunnerOptions represents the available EnableProjectRunner() options.

GitLab API docs: https://docs.gitlab.com/api/runners/#assign-a-runner-to-project

type EnabledGitAccessProtocolValue added in v1.40.1 

type EnabledGitAccessProtocolValue string

EnabledGitAccessProtocolValue represents a git access protocol value. 

const (
	EnabledGitAccessProtocolSSH  EnabledGitAccessProtocolValue = "ssh"
	EnabledGitAccessProtocolHTTP EnabledGitAccessProtocolValue = "http"
	EnabledGitAccessProtocolAll  EnabledGitAccessProtocolValue = "all"
)

type EnterpriseUsersService added in v0.128.0 

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

EnterpriseUsersService handles communication with the enterprise users related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_enterprise_users/

func (*EnterpriseUsersService) DeleteEnterpriseUser added in v0.151.0 

func (s *EnterpriseUsersService) DeleteEnterpriseUser(gid any, uid int64, opt *DeleteEnterpriseUserOptions, options ...RequestOptionFunc) (*Response, error)

DeleteEnterpriseUser deletes an specified enterprise user.

GitLab API docs: https://docs.gitlab.com/api/group_enterprise_users/#delete-an-enterprise-user

func (*EnterpriseUsersService) Disable2FAForEnterpriseUser added in v0.128.0 

func (s *EnterpriseUsersService) Disable2FAForEnterpriseUser(gid any, uid int64, options ...RequestOptionFunc) (*Response, error)

Disable2FAForEnterpriseUser disables two-factor authentication (2FA) for a specified enterprise user.

GitLab API docs: https://docs.gitlab.com/api/group_enterprise_users/#disable-two-factor-authentication-for-an-enterprise-user

func (*EnterpriseUsersService) GetEnterpriseUser added in v0.128.0 

func (s *EnterpriseUsersService) GetEnterpriseUser(gid any, uid int64, options ...RequestOptionFunc) (*User, *Response, error)

GetEnterpriseUser gets details on a specified enterprise user.

GitLab API docs: https://docs.gitlab.com/api/group_enterprise_users/#get-details-on-an-enterprise-user

func (*EnterpriseUsersService) ListEnterpriseUsers added in v0.128.0 

func (s *EnterpriseUsersService) ListEnterpriseUsers(gid any, opt *ListEnterpriseUsersOptions, options ...RequestOptionFunc) ([]*User, *Response, error)

type EnterpriseUsersServiceInterface added in v0.128.0 

type EnterpriseUsersServiceInterface interface {
	// ListEnterpriseUsers lists all enterprise users for a given top-level group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_enterprise_users/#list-all-enterprise-users
	ListEnterpriseUsers(gid any, opt *ListEnterpriseUsersOptions, options ...RequestOptionFunc) ([]*User, *Response, error)
	GetEnterpriseUser(gid any, uid int64, options ...RequestOptionFunc) (*User, *Response, error)
	Disable2FAForEnterpriseUser(gid any, uid int64, options ...RequestOptionFunc) (*Response, error)
	DeleteEnterpriseUser(gid any, uid int64, deleteOptions *DeleteEnterpriseUserOptions, options ...RequestOptionFunc) (*Response, error)
}

type Environment added in v0.7.0 

type Environment struct {
	ID                  int64       `json:"id"`
	Name                string      `json:"name"`
	Slug                string      `json:"slug"`
	Description         string      `json:"description"`
	State               string      `json:"state"`
	Tier                string      `json:"tier"`
	ExternalURL         string      `json:"external_url"`
	Project             *Project    `json:"project"`
	CreatedAt           *time.Time  `json:"created_at"`
	UpdatedAt           *time.Time  `json:"updated_at"`
	LastDeployment      *Deployment `json:"last_deployment"`
	ClusterAgent        *Agent      `json:"cluster_agent"`
	KubernetesNamespace string      `json:"kubernetes_namespace"`
	FluxResourcePath    string      `json:"flux_resource_path"`
	AutoStopAt          *time.Time  `json:"auto_stop_at"`
	AutoStopSetting     string      `json:"auto_stop_setting"`
}

Environment represents a GitLab environment.

GitLab API docs: https://docs.gitlab.com/api/environments/

func (Environment) String added in v0.7.0 

func (env Environment) String() string

type EnvironmentAccessDescription added in v0.116.0 

type EnvironmentAccessDescription struct {
	ID                     int64            `json:"id"`
	AccessLevel            AccessLevelValue `json:"access_level"`
	AccessLevelDescription string           `json:"access_level_description"`
	UserID                 int64            `json:"user_id"`
	GroupID                int64            `json:"group_id"`
	GroupInheritanceType   int64            `json:"group_inheritance_type"`
}

EnvironmentAccessDescription represents the access description for a protected environment.

GitLab API docs: https://docs.gitlab.com/api/protected_environments/

type EnvironmentAccessOptions added in v0.116.0 

type EnvironmentAccessOptions struct {
	AccessLevel          *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	UserID               *int64            `url:"user_id,omitempty" json:"user_id,omitempty"`
	GroupID              *int64            `url:"group_id,omitempty" json:"group_id,omitempty"`
	GroupInheritanceType *int64            `url:"group_inheritance_type,omitempty" json:"group_inheritance_type,omitempty"`
}

EnvironmentAccessOptions represents the options for an access description for a protected environment.

GitLab API docs: https://docs.gitlab.com/api/protected_environments/#protect-a-single-environment

type EnvironmentApprovalRule added in v0.116.0 

type EnvironmentApprovalRule struct {
	ID                     int64            `json:"id"`
	UserID                 int64            `json:"user_id"`
	GroupID                int64            `json:"group_id"`
	AccessLevel            AccessLevelValue `json:"access_level"`
	AccessLevelDescription string           `json:"access_level_description"`
	RequiredApprovalCount  int64            `json:"required_approvals"`
	GroupInheritanceType   int64            `json:"group_inheritance_type"`
}

EnvironmentApprovalRule represents the approval rules for a protected environment.

GitLab API docs: https://docs.gitlab.com/api/protected_environments/#protect-a-single-environment

type EnvironmentApprovalRuleOptions added in v0.116.0 

type EnvironmentApprovalRuleOptions struct {
	UserID                 *int64            `url:"user_id,omitempty" json:"user_id,omitempty"`
	GroupID                *int64            `url:"group_id,omitempty" json:"group_id,omitempty"`
	AccessLevel            *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	AccessLevelDescription *string           `url:"access_level_description,omitempty" json:"access_level_description,omitempty"`
	RequiredApprovalCount  *int64            `url:"required_approvals,omitempty" json:"required_approvals,omitempty"`
	GroupInheritanceType   *int64            `url:"group_inheritance_type,omitempty" json:"group_inheritance_type,omitempty"`
}

EnvironmentApprovalRuleOptions represents the approval rules for a protected environment.

GitLab API docs: https://docs.gitlab.com/api/protected_environments/#protect-a-single-environment

type EnvironmentsService added in v0.7.0 

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

EnvironmentsService handles communication with the environment related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/environments/

func (*EnvironmentsService) CreateEnvironment added in v0.7.0 

func (s *EnvironmentsService) CreateEnvironment(pid any, opt *CreateEnvironmentOptions, options ...RequestOptionFunc) (*Environment, *Response, error)

func (*EnvironmentsService) DeleteEnvironment added in v0.7.0 

func (s *EnvironmentsService) DeleteEnvironment(pid any, environment int64, options ...RequestOptionFunc) (*Response, error)

func (*EnvironmentsService) EditEnvironment added in v0.7.0 

func (s *EnvironmentsService) EditEnvironment(pid any, environment int64, opt *EditEnvironmentOptions, options ...RequestOptionFunc) (*Environment, *Response, error)

func (*EnvironmentsService) GetEnvironment added in v0.116.0 

func (s *EnvironmentsService) GetEnvironment(pid any, environment int64, options ...RequestOptionFunc) (*Environment, *Response, error)

func (*EnvironmentsService) ListEnvironments added in v0.7.0 

func (s *EnvironmentsService) ListEnvironments(pid any, opts *ListEnvironmentsOptions, options ...RequestOptionFunc) ([]*Environment, *Response, error)

func (*EnvironmentsService) StopEnvironment added in v0.116.0 

func (s *EnvironmentsService) StopEnvironment(pid any, environmentID int64, opt *StopEnvironmentOptions, options ...RequestOptionFunc) (*Environment, *Response, error)

type EnvironmentsServiceInterface added in v0.126.0 

type EnvironmentsServiceInterface interface {
	// ListEnvironments gets a list of environments from a project, sorted by name
	// alphabetically.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/environments/#list-environments
	ListEnvironments(pid any, opts *ListEnvironmentsOptions, options ...RequestOptionFunc) ([]*Environment, *Response, error)
	GetEnvironment(pid any, environment int64, options ...RequestOptionFunc) (*Environment, *Response, error)
	CreateEnvironment(pid any, opt *CreateEnvironmentOptions, options ...RequestOptionFunc) (*Environment, *Response, error)
	EditEnvironment(pid any, environment int64, opt *EditEnvironmentOptions, options ...RequestOptionFunc) (*Environment, *Response, error)
	DeleteEnvironment(pid any, environment int64, options ...RequestOptionFunc) (*Response, error)
	StopEnvironment(pid any, environmentID int64, opt *StopEnvironmentOptions, options ...RequestOptionFunc) (*Environment, *Response, error)
}

EnvironmentsServiceInterface defines all the API methods for the EnvironmentsService

type Epic added in v0.116.0 

type Epic struct {
	ID                      int64       `json:"id"`
	IID                     int64       `json:"iid"`
	GroupID                 int64       `json:"group_id"`
	ParentID                int64       `json:"parent_id"`
	Title                   string      `json:"title"`
	Description             string      `json:"description"`
	State                   string      `json:"state"`
	Confidential            bool        `json:"confidential"`
	WebURL                  string      `json:"web_url"`
	Author                  *EpicAuthor `json:"author"`
	StartDate               *ISOTime    `json:"start_date"`
	StartDateIsFixed        bool        `json:"start_date_is_fixed"`
	StartDateFixed          *ISOTime    `json:"start_date_fixed"`
	StartDateFromMilestones *ISOTime    `json:"start_date_from_milestones"`
	DueDate                 *ISOTime    `json:"due_date"`
	DueDateIsFixed          bool        `json:"due_date_is_fixed"`
	DueDateFixed            *ISOTime    `json:"due_date_fixed"`
	DueDateFromMilestones   *ISOTime    `json:"due_date_from_milestones"`
	CreatedAt               *time.Time  `json:"created_at"`
	UpdatedAt               *time.Time  `json:"updated_at"`
	ClosedAt                *time.Time  `json:"closed_at"`
	Labels                  []string    `json:"labels"`
	Upvotes                 int64       `json:"upvotes"`
	Downvotes               int64       `json:"downvotes"`
	UserNotesCount          int64       `json:"user_notes_count"`
	URL                     string      `json:"url"`
}

Epic represents a GitLab epic. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epics/

func (Epic) String added in v0.116.0 

func (e Epic) String() string

String gets a string representation of an Epic.

Will be removed in v5 of the API, use Work Items API instead

type EpicAuthor added in v0.116.0 

type EpicAuthor struct {
	ID        int64  `json:"id"`
	State     string `json:"state"`
	WebURL    string `json:"web_url"`
	Name      string `json:"name"`
	AvatarURL string `json:"avatar_url"`
	Username  string `json:"username"`
}

EpicAuthor represents a author of the epic. Will be removed in v5 of the API, use Work Items API instead

type EpicIssueAssignment added in v0.116.0 

type EpicIssueAssignment struct {
	ID    int64  `json:"id"`
	Epic  *Epic  `json:"epic"`
	Issue *Issue `json:"issue"`
}

EpicIssueAssignment contains both the epic and issue objects returned from GitLab with the assignment ID. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epic_issues/

type EpicIssuesService added in v0.116.0 

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

EpicIssuesService handles communication with the epic issue related methods of the GitLab API. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epic_issues/

func (*EpicIssuesService) AssignEpicIssue added in v0.116.0 

func (s *EpicIssuesService) AssignEpicIssue(gid any, epic, issue int64, options ...RequestOptionFunc) (*EpicIssueAssignment, *Response, error)

AssignEpicIssue assigns an existing issue to an epic. Will be removed in v5 of the API, use Work Items API instead

Gitlab API Docs: https://docs.gitlab.com/api/epic_issues/#assign-an-issue-to-the-epic

func (*EpicIssuesService) ListEpicIssues added in v0.116.0 

func (s *EpicIssuesService) ListEpicIssues(gid any, epic int64, opt *ListOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)

ListEpicIssues get a list of epic issues. Will be removed in v5 of the API, use Work Items API instead

Gitlab API docs: https://docs.gitlab.com/api/epic_issues/#list-issues-for-an-epic

func (*EpicIssuesService) RemoveEpicIssue added in v0.116.0 

func (s *EpicIssuesService) RemoveEpicIssue(gid any, epic, epicIssue int64, options ...RequestOptionFunc) (*EpicIssueAssignment, *Response, error)

RemoveEpicIssue removes an issue from an epic. Will be removed in v5 of the API, use Work Items API instead

Gitlab API Docs: https://docs.gitlab.com/api/epic_issues/#remove-an-issue-from-the-epic

func (*EpicIssuesService) UpdateEpicIssueAssignment added in v0.116.0 

func (s *EpicIssuesService) UpdateEpicIssueAssignment(gid any, epic, epicIssue int64, opt *UpdateEpicIssueAssignmentOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)

UpdateEpicIssueAssignment moves an issue before or after another issue in an epic issue list. Will be removed in v5 of the API, use Work Items API instead

Gitlab API Docs: https://docs.gitlab.com/api/epic_issues/#update-epic---issue-association

type EpicIssuesServiceInterface added in v0.126.0 

type EpicIssuesServiceInterface interface {
	// Will be removed in v5 of the API, use Work Items API instead
	ListEpicIssues(gid any, epic int64, opt *ListOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)
	// Will be removed in v5 of the API, use Work Items API instead
	AssignEpicIssue(gid any, epic, issue int64, options ...RequestOptionFunc) (*EpicIssueAssignment, *Response, error)
	// Will be removed in v5 of the API, use Work Items API instead
	RemoveEpicIssue(gid any, epic, epicIssue int64, options ...RequestOptionFunc) (*EpicIssueAssignment, *Response, error)
	// Will be removed in v5 of the API, use Work Items API instead
	UpdateEpicIssueAssignment(gid any, epic, epicIssue int64, opt *UpdateEpicIssueAssignmentOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)
}

EpicIssuesServiceInterface defines all the API methods for the EpicIssuesService Will be removed in v5 of the API, use Work Items API instead

type EpicsService added in v0.116.0 

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

EpicsService handles communication with the epic related methods of the GitLab API. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epics/

func (*EpicsService) CreateEpic added in v0.116.0 

func (s *EpicsService) CreateEpic(gid any, opt *CreateEpicOptions, options ...RequestOptionFunc) (*Epic, *Response, error)

func (*EpicsService) DeleteEpic added in v0.116.0 

func (s *EpicsService) DeleteEpic(gid any, epic int64, options ...RequestOptionFunc) (*Response, error)

DeleteEpic deletes a single group epic. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epics/#delete-epic

func (*EpicsService) GetEpic added in v0.116.0 

func (s *EpicsService) GetEpic(gid any, epic int64, options ...RequestOptionFunc) (*Epic, *Response, error)

GetEpic gets a single group epic. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epics/#single-epic 

func (s *EpicsService) GetEpicLinks(gid any, epic int64, options ...RequestOptionFunc) ([]*Epic, *Response, error)

GetEpicLinks gets all child epics of an epic. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epic_links/

func (*EpicsService) ListGroupEpics added in v0.116.0 

func (s *EpicsService) ListGroupEpics(gid any, opt *ListGroupEpicsOptions, options ...RequestOptionFunc) ([]*Epic, *Response, error)

func (*EpicsService) UpdateEpic added in v0.116.0 

func (s *EpicsService) UpdateEpic(gid any, epic int64, opt *UpdateEpicOptions, options ...RequestOptionFunc) (*Epic, *Response, error)

UpdateEpic updates an existing group epic. This function is also used to mark an epic as closed. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epics/#update-epic

type EpicsServiceInterface added in v0.126.0 

type EpicsServiceInterface interface {
	// ListGroupEpics gets a list of group epics. This function accepts pagination
	// parameters page and per_page to return the list of group epics.
	// Will be removed in v5 of the API, use Work Items API instead
	//
	// GitLab API docs: https://docs.gitlab.com/api/epics/#list-epics-for-a-group
	ListGroupEpics(gid any, opt *ListGroupEpicsOptions, options ...RequestOptionFunc) ([]*Epic, *Response, error)

	// GetEpic gets a single group epic.
	// Will be removed in v5 of the API, use Work Items API instead
	GetEpic(gid any, epic int64, options ...RequestOptionFunc) (*Epic, *Response, error)
	// Will be removed in v5 of the API, use Work Items API instead
	GetEpicLinks(gid any, epic int64, options ...RequestOptionFunc) ([]*Epic, *Response, error)
	// Will be removed in v5 of the API, use Work Items API instead
	//
	// GitLab API docs: https://docs.gitlab.com/api/epics/#new-epic
	CreateEpic(gid any, opt *CreateEpicOptions, options ...RequestOptionFunc) (*Epic, *Response, error)

	// UpdateEpic updates an existing group epic. This function is also used
	// to mark an epic as closed.
	// Will be removed in v5 of the API, use Work Items API instead
	UpdateEpic(gid any, epic int64, opt *UpdateEpicOptions, options ...RequestOptionFunc) (*Epic, *Response, error)
	// Will be removed in v5 of the API, use Work Items API instead
	DeleteEpic(gid any, epic int64, options ...RequestOptionFunc) (*Response, error)
}

EpicsServiceInterface defines all the API methods for the EpicsService Will be removed in v5 of the API, use Work Items API instead

type ErrorResponse 

type ErrorResponse struct {
	Body     []byte
	Response *http.Response
	Message  string
}

An ErrorResponse reports one or more errors caused by an API request.

GitLab API docs: https://docs.gitlab.com/api/rest/troubleshooting/

func (*ErrorResponse) Error 

func (e *ErrorResponse) Error() string

func (*ErrorResponse) HasStatusCode added in v0.136.0 

func (e *ErrorResponse) HasStatusCode(statusCode int) bool

type ErrorTrackingClientKey added in v0.116.0 

type ErrorTrackingClientKey struct {
	ID        int64  `json:"id"`
	Active    bool   `json:"active"`
	PublicKey string `json:"public_key"`
	SentryDsn string `json:"sentry_dsn"`
}

ErrorTrackingClientKey represents an error tracking client key.

GitLab docs: https://docs.gitlab.com/api/error_tracking/#error-tracking-client-keys

func (ErrorTrackingClientKey) String added in v0.116.0 

func (p ErrorTrackingClientKey) String() string

type ErrorTrackingService added in v0.116.0 

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

ErrorTrackingService handles communication with the error tracking methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/error_tracking/

func (*ErrorTrackingService) CreateClientKey added in v0.116.0 

func (s *ErrorTrackingService) CreateClientKey(pid any, options ...RequestOptionFunc) (*ErrorTrackingClientKey, *Response, error)

func (*ErrorTrackingService) DeleteClientKey added in v0.116.0 

func (s *ErrorTrackingService) DeleteClientKey(pid any, keyID int64, options ...RequestOptionFunc) (*Response, error)

DeleteClientKey removes a client key from the project.

GitLab API docs: https://docs.gitlab.com/api/error_tracking/#delete-a-client-key

func (*ErrorTrackingService) EnableDisableErrorTracking added in v0.116.0 

func (s *ErrorTrackingService) EnableDisableErrorTracking(pid any, opt *EnableDisableErrorTrackingOptions, options ...RequestOptionFunc) (*ErrorTrackingSettings, *Response, error)

func (*ErrorTrackingService) GetErrorTrackingSettings added in v0.116.0 

func (s *ErrorTrackingService) GetErrorTrackingSettings(pid any, options ...RequestOptionFunc) (*ErrorTrackingSettings, *Response, error)

func (*ErrorTrackingService) ListClientKeys added in v0.116.0 

func (s *ErrorTrackingService) ListClientKeys(pid any, opt *ListClientKeysOptions, options ...RequestOptionFunc) ([]*ErrorTrackingClientKey, *Response, error)

type ErrorTrackingServiceInterface added in v0.126.0 

type ErrorTrackingServiceInterface interface {
	// GetErrorTrackingSettings gets error tracking settings.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/error_tracking/#get-error-tracking-settings
	GetErrorTrackingSettings(pid any, options ...RequestOptionFunc) (*ErrorTrackingSettings, *Response, error)

	// EnableDisableErrorTracking allows you to enable or disable the error tracking
	// settings for a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/error_tracking/#enable-or-disable-the-error-tracking-project-settings
	EnableDisableErrorTracking(pid any, opt *EnableDisableErrorTrackingOptions, options ...RequestOptionFunc) (*ErrorTrackingSettings, *Response, error)

	// ListClientKeys lists error tracking project client keys.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/error_tracking/#list-project-client-keys
	ListClientKeys(pid any, opt *ListClientKeysOptions, options ...RequestOptionFunc) ([]*ErrorTrackingClientKey, *Response, error)

	// CreateClientKey creates a new client key for a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/error_tracking/#create-a-client-key
	CreateClientKey(pid any, options ...RequestOptionFunc) (*ErrorTrackingClientKey, *Response, error)

	// DeleteClientKey removes a client key from the project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/error_tracking/#delete-a-client-key
	DeleteClientKey(pid any, keyID int64, options ...RequestOptionFunc) (*Response, error)
}

ErrorTrackingServiceInterface defines all the API methods for the ErrorTrackingService

type ErrorTrackingSettings added in v0.116.0 

type ErrorTrackingSettings struct {
	Active            bool   `json:"active"`
	ProjectName       string `json:"project_name"`
	SentryExternalURL string `json:"sentry_external_url"`
	APIURL            string `json:"api_url"`
	Integrated        bool   `json:"integrated"`
}

ErrorTrackingSettings represents error tracking settings for a GitLab project.

GitLab API docs: https://docs.gitlab.com/api/error_tracking/#error-tracking-project-settings

func (ErrorTrackingSettings) String added in v0.116.0 

func (p ErrorTrackingSettings) String() string

type EventChangesAssignees added in v1.0.0 

type EventChangesAssignees struct {
	Previous []*EventUser `json:"previous"`
	Current  []*EventUser `json:"current"`
}

type EventChangesDescription added in v1.0.0 

type EventChangesDescription struct {
	Previous string `json:"previous"`
	Current  string `json:"current"`
}

type EventChangesLabels added in v1.0.0 

type EventChangesLabels struct {
	Previous []*EventLabel `json:"previous"`
	Current  []*EventLabel `json:"current"`
}

type EventChangesStateID added in v1.0.0 

type EventChangesStateID struct {
	Previous StateID `json:"previous"`
	Current  StateID `json:"current"`
}

type EventChangesTitle added in v1.0.0 

type EventChangesTitle struct {
	Previous string `json:"previous"`
	Current  string `json:"current"`
}

type EventChangesUpdatedAt added in v1.0.0 

type EventChangesUpdatedAt struct {
	Previous string `json:"previous"`
	Current  string `json:"current"`
}

type EventChangesUpdatedByID added in v1.0.0 

type EventChangesUpdatedByID struct {
	Previous int64 `json:"previous"`
	Current  int64 `json:"current"`
}

type EventCommitAuthor added in v1.0.0 

type EventCommitAuthor struct {
	Name  string `json:"name"`
	Email string `json:"email"`
}

type EventEnvironment added in v1.0.0 

type EventEnvironment struct {
	Name           string `json:"name"`
	Action         string `json:"action"`
	DeploymentTier string `json:"deployment_tier"`
}

type EventLabel added in v0.116.0 

type EventLabel struct {
	ID          int64  `json:"id"`
	Title       string `json:"title"`
	Color       string `json:"color"`
	ProjectID   int64  `json:"project_id"`
	CreatedAt   string `json:"created_at"`
	UpdatedAt   string `json:"updated_at"`
	Template    bool   `json:"template"`
	Description string `json:"description"`
	Type        string `json:"type"`
	GroupID     int64  `json:"group_id"`
}

EventLabel represents a label inside a webhook event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#work-item-events

type EventMergeRequestLastCommit added in v1.0.0 

type EventMergeRequestLastCommit struct {
	ID        string            `json:"id"`
	Title     string            `json:"title"`
	Message   string            `json:"message"`
	Timestamp *time.Time        `json:"timestamp"`
	URL       string            `json:"url"`
	Author    EventCommitAuthor `json:"author"`
}

type EventSourcePipeline added in v1.0.0 

type EventSourcePipeline struct {
	Project    EventSourcePipelineProject `json:"project"`
	PipelineID int64                      `json:"pipeline_id"`
	JobID      int64                      `json:"job_id"`
}

type EventSourcePipelineProject added in v1.0.0 

type EventSourcePipelineProject struct {
	ID                int64  `json:"id"`
	WebURL            string `json:"web_url"`
	PathWithNamespace string `json:"path_with_namespace"`
}

type EventTargetTypeValue added in v0.8.0 

type EventTargetTypeValue string

EventTargetTypeValue represents actions type value for contribution events. 

const (
	IssueEventTargetType        EventTargetTypeValue = "issue"
	MilestoneEventTargetType    EventTargetTypeValue = "milestone"
	MergeRequestEventTargetType EventTargetTypeValue = "merge_request"
	NoteEventTargetType         EventTargetTypeValue = "note"
	ProjectEventTargetType      EventTargetTypeValue = "project"
	SnippetEventTargetType      EventTargetTypeValue = "snippet"
	UserEventTargetType         EventTargetTypeValue = "user"
)

List of available action type.

GitLab API docs: https://docs.gitlab.com/api/events/#target-types

type EventType added in v0.116.0 

type EventType string

EventType represents a GitLab event type. 

const (
	EventConfidentialIssue       EventType = "Confidential Issue Hook"
	EventConfidentialNote        EventType = "Confidential Note Hook"
	EventTypeBuild               EventType = "Build Hook"
	EventTypeDeployment          EventType = "Deployment Hook"
	EventTypeEmoji               EventType = "Emoji Hook"
	EventTypeFeatureFlag         EventType = "Feature Flag Hook"
	EventTypeIssue               EventType = "Issue Hook"
	EventTypeJob                 EventType = "Job Hook"
	EventTypeMember              EventType = "Member Hook"
	EventTypeMergeRequest        EventType = "Merge Request Hook"
	EventTypeMilestone           EventType = "Milestone Hook"
	EventTypeNote                EventType = "Note Hook"
	EventTypePipeline            EventType = "Pipeline Hook"
	EventTypeProject             EventType = "Project Hook"
	EventTypePush                EventType = "Push Hook"
	EventTypeRelease             EventType = "Release Hook"
	EventTypeResourceAccessToken EventType = "Resource Access Token Hook"
	EventTypeServiceHook         EventType = "Service Hook"
	EventTypeSubGroup            EventType = "Subgroup Hook"
	EventTypeSystemHook          EventType = "System Hook"
	EventTypeTagPush             EventType = "Tag Push Hook"
	EventTypeVulnerability       EventType = "Vulnerability Hook"
	EventTypeWikiPage            EventType = "Wiki Page Hook"
)

List of available event types.

func HookEventType added in v0.116.0 

func HookEventType(r *http.Request) EventType

HookEventType returns the event type for the given request.

func WebhookEventType added in v0.116.0 

func WebhookEventType(r *http.Request) EventType

WebhookEventType returns the event type for the given request.

type EventTypeValue added in v0.8.0 

type EventTypeValue string

EventTypeValue represents actions type for contribution events. 

const (
	CreatedEventType   EventTypeValue = "created"
	UpdatedEventType   EventTypeValue = "updated"
	ClosedEventType    EventTypeValue = "closed"
	ReopenedEventType  EventTypeValue = "reopened"
	PushedEventType    EventTypeValue = "pushed"
	CommentedEventType EventTypeValue = "commented"
	MergedEventType    EventTypeValue = "merged"
	JoinedEventType    EventTypeValue = "joined"
	LeftEventType      EventTypeValue = "left"
	DestroyedEventType EventTypeValue = "destroyed"
	ExpiredEventType   EventTypeValue = "expired"
)

List of available action type.

GitLab API docs: https://docs.gitlab.com/user/profile/contributions_calendar/#user-contribution-events

type EventUser added in v0.116.0 

type EventUser struct {
	ID        int64  `json:"id"`
	Name      string `json:"name"`
	Username  string `json:"username"`
	AvatarURL string `json:"avatar_url"`
	Email     string `json:"email"`
}

EventUser represents a user record in an event and is used as an event initiator or a merge assignee.

type EventsService added in v0.8.0 

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

EventsService handles communication with the event related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/events/

func (*EventsService) ListCurrentUserContributionEvents added in v0.8.0 

func (s *EventsService) ListCurrentUserContributionEvents(opt *ListContributionEventsOptions, options ...RequestOptionFunc) ([]*ContributionEvent, *Response, error)

func (*EventsService) ListProjectVisibleEvents added in v0.11.0 

func (s *EventsService) ListProjectVisibleEvents(pid any, opt *ListProjectVisibleEventsOptions, options ...RequestOptionFunc) ([]*ProjectEvent, *Response, error)

type EventsServiceInterface added in v0.126.0 

type EventsServiceInterface interface {
	// ListCurrentUserContributionEvents  retrieves all events
	// for the currently authenticated user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/events/#list-all-events
	ListCurrentUserContributionEvents(opt *ListContributionEventsOptions, options ...RequestOptionFunc) ([]*ContributionEvent, *Response, error)

	// ListProjectVisibleEvents gets the events for the specified project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/events/#list-a-projects-visible-events
	ListProjectVisibleEvents(pid any, opt *ListProjectVisibleEventsOptions, options ...RequestOptionFunc) ([]*ProjectEvent, *Response, error)
}

EventsServiceInterface defines all the API methods for the EventsService

type ExploreSnippetsOptions added in v0.7.5 

type ExploreSnippetsOptions struct {
	ListOptions
}

ExploreSnippetsOptions represents the available ExploreSnippets() options.

GitLab API docs: https://docs.gitlab.com/api/snippets/#list-all-public-snippets

type ExportStatus added in v0.116.0 

type ExportStatus struct {
	ID                int64             `json:"id"`
	Description       string            `json:"description"`
	Name              string            `json:"name"`
	NameWithNamespace string            `json:"name_with_namespace"`
	Path              string            `json:"path"`
	PathWithNamespace string            `json:"path_with_namespace"`
	CreatedAt         *time.Time        `json:"created_at"`
	ExportStatus      string            `json:"export_status"`
	Message           string            `json:"message"`
	Links             ExportStatusLinks `json:"_links"`
}

ExportStatus represents a project export status.

GitLab API docs: https://docs.gitlab.com/api/project_import_export/#export-status

func (ExportStatus) String added in v0.116.0 

func (s ExportStatus) String() string
type ExportStatusLinks struct {
	APIURL string `json:"api_url"`
	WebURL string `json:"web_url"`
}

ExportStatusLinks represents the project export status links.

GitLab API docs: https://docs.gitlab.com/api/project_import_export/#export-status

func (ExportStatusLinks) String added in v1.0.0 

func (l ExportStatusLinks) String() string

type ExternalStatusChecksService added in v0.116.0 

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

ExternalStatusChecksService handles communication with the external status check related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/status_checks/

func (*ExternalStatusChecksService) CreateExternalStatusCheck added in v0.116.0 

func (s *ExternalStatusChecksService) CreateExternalStatusCheck(pid any, opt *CreateExternalStatusCheckOptions, options ...RequestOptionFunc) (*Response, error)

func (*ExternalStatusChecksService) CreateProjectExternalStatusCheck added in v0.138.0 

func (s *ExternalStatusChecksService) CreateProjectExternalStatusCheck(pid any, opt *CreateProjectExternalStatusCheckOptions, options ...RequestOptionFunc) (*ProjectStatusCheck, *Response, error)

func (*ExternalStatusChecksService) DeleteExternalStatusCheck added in v0.116.0 

func (s *ExternalStatusChecksService) DeleteExternalStatusCheck(pid any, check int64, options ...RequestOptionFunc) (*Response, error)

DeleteExternalStatusCheck deletes an external status check. Deprecated: to be removed in 1.0; use DeleteProjectExternalStatusCheck instead

Gitlab API docs: https://docs.gitlab.com/api/status_checks/#delete-external-status-check-service

func (*ExternalStatusChecksService) DeleteProjectExternalStatusCheck added in v0.138.0 

func (s *ExternalStatusChecksService) DeleteProjectExternalStatusCheck(pid any, check int64, opt *DeleteProjectExternalStatusCheckOptions, options ...RequestOptionFunc) (*Response, error)

DeleteProjectExternalStatusCheck deletes an external status check.

Gitlab API docs: https://docs.gitlab.com/api/status_checks/#delete-external-status-check-service

func (*ExternalStatusChecksService) ListMergeStatusChecks added in v0.116.0 

func (s *ExternalStatusChecksService) ListMergeStatusChecks(pid any, mr int64, opt *ListOptions, options ...RequestOptionFunc) ([]*MergeStatusCheck, *Response, error)

ListMergeStatusChecks lists the external status checks that apply to it and their status for a single merge request. Deprecated: to be removed in 1.0; use ListProjectMergeRequestExternalStatusChecks instead

GitLab API docs: https://docs.gitlab.com/api/status_checks/#list-status-checks-for-a-merge-request

func (*ExternalStatusChecksService) ListProjectExternalStatusChecks added in v0.138.0 

func (s *ExternalStatusChecksService) ListProjectExternalStatusChecks(pid any, opt *ListProjectExternalStatusChecksOptions, options ...RequestOptionFunc) ([]*ProjectStatusCheck, *Response, error)

func (*ExternalStatusChecksService) ListProjectMergeRequestExternalStatusChecks added in v0.138.0 

func (s *ExternalStatusChecksService) ListProjectMergeRequestExternalStatusChecks(pid any, mr int64, opt *ListProjectMergeRequestExternalStatusChecksOptions, options ...RequestOptionFunc) ([]*MergeStatusCheck, *Response, error)

ListProjectMergeRequestExternalStatusChecks lists the external status checks that apply to it and their status for a single merge request.

GitLab API docs: https://docs.gitlab.com/api/status_checks/#list-status-checks-for-a-merge-request

func (*ExternalStatusChecksService) ListProjectStatusChecks added in v0.116.0 

func (s *ExternalStatusChecksService) ListProjectStatusChecks(pid any, opt *ListOptions, options ...RequestOptionFunc) ([]*ProjectStatusCheck, *Response, error)

func (*ExternalStatusChecksService) RetryFailedExternalStatusCheckForProjectMergeRequest added in v0.138.0 

func (s *ExternalStatusChecksService) RetryFailedExternalStatusCheckForProjectMergeRequest(pid any, mergeRequest int64, externalStatusCheck int64, opt *RetryFailedExternalStatusCheckForProjectMergeRequestOptions, options ...RequestOptionFunc) (*Response, error)

RetryFailedExternalStatusCheckForProjectMergeRequest retries the specified failed external status check.

Gitlab API docs: https://docs.gitlab.com/api/status_checks/#retry-failed-status-check-for-a-merge-request

func (*ExternalStatusChecksService) RetryFailedStatusCheckForAMergeRequest added in v0.116.0 

func (s *ExternalStatusChecksService) RetryFailedStatusCheckForAMergeRequest(pid any, mergeRequest int64, externalStatusCheck int64, options ...RequestOptionFunc) (*Response, error)

RetryFailedStatusCheckForAMergeRequest retries the specified failed external status check. Deprecated: to be removed in 1.0; use RetryFailedExternalStatusCheckForProjectMergeRequest instead

Gitlab API docs: https://docs.gitlab.com/api/status_checks/#retry-failed-status-check-for-a-merge-request

func (*ExternalStatusChecksService) SetExternalStatusCheckStatus added in v0.116.0 

func (s *ExternalStatusChecksService) SetExternalStatusCheckStatus(pid any, mergeRequest int64, opt *SetExternalStatusCheckStatusOptions, options ...RequestOptionFunc) (*Response, error)

SetExternalStatusCheckStatus sets the status of an external status check. Deprecated: to be removed in 1.0; use SetProjectMergeRequestExternalStatusCheckStatus instead

Gitlab API docs: https://docs.gitlab.com/api/status_checks/#set-status-of-an-external-status-check

func (*ExternalStatusChecksService) SetProjectMergeRequestExternalStatusCheckStatus added in v0.138.0 

func (s *ExternalStatusChecksService) SetProjectMergeRequestExternalStatusCheckStatus(pid any, mergeRequest int64, opt *SetProjectMergeRequestExternalStatusCheckStatusOptions, options ...RequestOptionFunc) (*Response, error)

SetProjectMergeRequestExternalStatusCheckStatus sets the status of an external status check.

Gitlab API docs: https://docs.gitlab.com/api/status_checks/#set-status-of-an-external-status-check

func (*ExternalStatusChecksService) UpdateExternalStatusCheck added in v0.116.0 

func (s *ExternalStatusChecksService) UpdateExternalStatusCheck(pid any, check int64, opt *UpdateExternalStatusCheckOptions, options ...RequestOptionFunc) (*Response, error)

UpdateExternalStatusCheck updates an external status check. Deprecated: to be removed in 1.0; use UpdateProjectExternalStatusCheck instead

Gitlab API docs: https://docs.gitlab.com/api/status_checks/#update-external-status-check-service

func (*ExternalStatusChecksService) UpdateProjectExternalStatusCheck added in v0.138.0 

func (s *ExternalStatusChecksService) UpdateProjectExternalStatusCheck(pid any, check int64, opt *UpdateProjectExternalStatusCheckOptions, options ...RequestOptionFunc) (*ProjectStatusCheck, *Response, error)

UpdateProjectExternalStatusCheck updates an external status check.

Gitlab API docs: https://docs.gitlab.com/api/status_checks/#update-external-status-check-service

type ExternalStatusChecksServiceInterface added in v0.126.0 

type ExternalStatusChecksServiceInterface interface {
	// CreateExternalStatusCheck creates an external status check.
	// Deprecated: to be removed in 1.0; use CreateProjectExternalStatusCheck instead
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#create-external-status-check-service
	CreateExternalStatusCheck(pid any, opt *CreateExternalStatusCheckOptions, options ...RequestOptionFunc) (*Response, error)

	// DeleteExternalStatusCheck deletes an external status check.
	// Deprecated: to be removed in 1.0; use DeleteProjectExternalStatusCheck instead
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#delete-external-status-check-service
	DeleteExternalStatusCheck(pid any, check int64, options ...RequestOptionFunc) (*Response, error)

	// UpdateExternalStatusCheck updates an external status check.
	// Deprecated: to be removed in 1.0; use UpdateProjectExternalStatusCheck instead
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#update-external-status-check-service
	UpdateExternalStatusCheck(pid any, check int64, opt *UpdateExternalStatusCheckOptions, options ...RequestOptionFunc) (*Response, error)

	// ListMergeStatusChecks lists the external status checks that apply to it
	// and their status for a single merge request.
	// Deprecated: to be removed in 1.0; use ListProjectMergeRequestExternalStatusChecks instead
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#list-status-checks-for-a-merge-request
	ListMergeStatusChecks(pid any, mr int64, opt *ListOptions, options ...RequestOptionFunc) ([]*MergeStatusCheck, *Response, error)

	// ListProjectStatusChecks lists the project external status checks.
	// Deprecated: to be removed in 1.0; use ListProjectExternalStatusChecks instead
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#get-project-external-status-check-services
	ListProjectStatusChecks(pid any, opt *ListOptions, options ...RequestOptionFunc) ([]*ProjectStatusCheck, *Response, error)

	// RetryFailedStatusCheckForAMergeRequest retries the specified failed external status check.
	// Deprecated: to be removed in 1.0; use RetryFailedExternalStatusCheckForProjectMergeRequest instead
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#retry-failed-status-check-for-a-merge-request
	RetryFailedStatusCheckForAMergeRequest(pid any, mergeRequest int64, externalStatusCheck int64, options ...RequestOptionFunc) (*Response, error)

	// SetExternalStatusCheckStatus sets the status of an external status check.
	// Deprecated: to be removed in 1.0; use SetProjectMergeRequestExternalStatusCheckStatus instead
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#set-status-of-an-external-status-check
	SetExternalStatusCheckStatus(pid any, mergeRequest int64, opt *SetExternalStatusCheckStatusOptions, options ...RequestOptionFunc) (*Response, error)

	// ListProjectMergeRequestExternalStatusChecks lists the external status checks that apply to it
	// and their status for a single merge request.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#list-status-checks-for-a-merge-request
	ListProjectMergeRequestExternalStatusChecks(pid any, mr int64, opt *ListProjectMergeRequestExternalStatusChecksOptions, options ...RequestOptionFunc) ([]*MergeStatusCheck, *Response, error)

	// ListProjectExternalStatusChecks lists the project external status checks.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#get-project-external-status-check-services
	ListProjectExternalStatusChecks(pid any, opt *ListProjectExternalStatusChecksOptions, options ...RequestOptionFunc) ([]*ProjectStatusCheck, *Response, error)

	// RetryFailedExternalStatusCheckForProjectMergeRequest retries the specified failed external status check.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#retry-failed-status-check-for-a-merge-request
	RetryFailedExternalStatusCheckForProjectMergeRequest(pid any, mergeRequest int64, externalStatusCheck int64, opt *RetryFailedExternalStatusCheckForProjectMergeRequestOptions, options ...RequestOptionFunc) (*Response, error)

	// CreateProjectExternalStatusCheck creates an external status check.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#create-external-status-check-service
	CreateProjectExternalStatusCheck(pid any, opt *CreateProjectExternalStatusCheckOptions, options ...RequestOptionFunc) (*ProjectStatusCheck, *Response, error)

	// UpdateProjectExternalStatusCheck updates an external status check.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#update-external-status-check-service
	UpdateProjectExternalStatusCheck(pid any, check int64, opt *UpdateProjectExternalStatusCheckOptions, options ...RequestOptionFunc) (*ProjectStatusCheck, *Response, error)

	// DeleteProjectExternalStatusCheck deletes an external status check.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#delete-external-status-check-service
	DeleteProjectExternalStatusCheck(pid any, check int64, opt *DeleteProjectExternalStatusCheckOptions, options ...RequestOptionFunc) (*Response, error)

	// SetProjectMergeRequestExternalStatusCheckStatus sets the status of an external status check.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/status_checks/#set-status-of-an-external-status-check
	SetProjectMergeRequestExternalStatusCheckStatus(pid any, mergeRequest int64, opt *SetProjectMergeRequestExternalStatusCheckStatusOptions, options ...RequestOptionFunc) (*Response, error)
}

ExternalStatusChecksServiceInterface defines all the API methods for the ExternalStatusChecksService

type ExternalWikiService added in v0.116.0 

type ExternalWikiService struct {
	Service
	Properties *ExternalWikiServiceProperties `json:"properties"`
}

ExternalWikiService represents External Wiki service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#external-wiki

type ExternalWikiServiceProperties added in v0.116.0 

type ExternalWikiServiceProperties struct {
	ExternalWikiURL string `json:"external_wiki_url"`
}

ExternalWikiServiceProperties represents External Wiki specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#external-wiki

type Feature added in v0.6.0 

type Feature struct {
	Name       string `json:"name"`
	State      string `json:"state"`
	Gates      []Gate
	Definition *FeatureDefinition `json:"definition"`
}

Feature represents a GitLab feature flag.

GitLab API docs: https://docs.gitlab.com/api/features/

func (Feature) String added in v0.6.0 

func (f Feature) String() string

type FeatureDefinition added in v0.129.0 

type FeatureDefinition struct {
	Name            string `json:"name"`
	IntroducedByURL string `json:"introduced_by_url"`
	RolloutIssueURL string `json:"rollout_issue_url"`
	Milestone       string `json:"milestone"`
	LogStateChanges bool   `json:"log_state_changes"`
	Type            string `json:"type"`
	Group           string `json:"group"`
	DefaultEnabled  bool   `json:"default_enabled"`
}

FeatureDefinition represents a Feature Definition.

GitLab API docs: https://docs.gitlab.com/api/features/#list-all-feature-definitions

func (FeatureDefinition) String added in v0.129.0 

func (fd FeatureDefinition) String() string

type FeatureFlagEvent added in v0.116.0 

type FeatureFlagEvent struct {
	ObjectKind       string                           `json:"object_kind"`
	Project          FeatureFlagEventProject          `json:"project"`
	User             *EventUser                       `json:"user"`
	UserURL          string                           `json:"user_url"`
	ObjectAttributes FeatureFlagEventObjectAttributes `json:"object_attributes"`
}

FeatureFlagEvent represents a feature flag event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#feature-flag-events

type FeatureFlagEventObjectAttributes added in v1.0.0 

type FeatureFlagEventObjectAttributes struct {
	ID          int64  `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	Active      bool   `json:"active"`
}

type FeatureFlagEventProject added in v1.0.0 

type FeatureFlagEventProject struct {
	ID                int64   `json:"id"`
	Name              string  `json:"name"`
	Description       string  `json:"description"`
	AvatarURL         *string `json:"avatar_url"`
	GitSSHURL         string  `json:"git_ssh_url"`
	GitHTTPURL        string  `json:"git_http_url"`
	Namespace         string  `json:"namespace"`
	PathWithNamespace string  `json:"path_with_namespace"`
	DefaultBranch     string  `json:"default_branch"`
	Homepage          string  `json:"homepage"`
	URL               string  `json:"url"`
	SSHURL            string  `json:"ssh_url"`
	HTTPURL           string  `json:"http_url"`
	WebURL            string  `json:"web_url"`
	VisibilityLevel   int64   `json:"visibility_level"`
	CIConfigPath      string  `json:"ci_config_path"`
}

type FeatureFlagStrategyOptions added in v0.116.0 

type FeatureFlagStrategyOptions struct {
	ID         *int64                               `url:"id,omitempty" json:"id,omitempty"`
	Name       *string                              `url:"name,omitempty" json:"name,omitempty"`
	Parameters *ProjectFeatureFlagStrategyParameter `url:"parameters,omitempty" json:"parameters,omitempty"`
	Scopes     *[]*ProjectFeatureFlagScope          `url:"scopes,omitempty" json:"scopes,omitempty"`
}

FeatureFlagStrategyOptions represents the available feature flag strategy options.

GitLab API docs: https://docs.gitlab.com/api/feature_flags/#create-a-feature-flag

type FeatureFlagUserList added in v0.128.0 

type FeatureFlagUserList struct {
	Name      string     `url:"name" json:"name"`
	UserXIDs  string     `url:"user_xids" json:"user_xids"`
	ID        int64      `url:"id" json:"id"`
	IID       int64      `url:"iid" json:"iid"`
	ProjectID int64      `url:"project_id" json:"project_id"`
	CreatedAt *time.Time `url:"created_at" json:"created_at"`
	UpdatedAt *time.Time `url:"updated_at" json:"updated_at"`
}

FeatureFlagUserList represents a project feature flag user list.

GitLab API docs: https://docs.gitlab.com/api/feature_flag_user_lists/

type FeatureFlagUserListsService added in v0.128.0 

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

FeatureFlagUserListsService handles communication with the feature flag user list related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/feature_flag_user_lists/

func (*FeatureFlagUserListsService) CreateFeatureFlagUserList added in v0.128.0 

func (s *FeatureFlagUserListsService) CreateFeatureFlagUserList(pid any, opt *CreateFeatureFlagUserListOptions, options ...RequestOptionFunc) (*FeatureFlagUserList, *Response, error)

CreateFeatureFlagUserList creates a feature flag user list.

GitLab API docs: https://docs.gitlab.com/api/feature_flag_user_lists/#create-a-feature-flag-user-list

func (*FeatureFlagUserListsService) DeleteFeatureFlagUserList added in v0.128.0 

func (s *FeatureFlagUserListsService) DeleteFeatureFlagUserList(pid any, iid int64, options ...RequestOptionFunc) (*Response, error)

DeleteFeatureFlagUserList deletes a feature flag user list.

GitLab API docs: https://docs.gitlab.com/api/feature_flag_user_lists/#delete-feature-flag-user-list

func (*FeatureFlagUserListsService) GetFeatureFlagUserList added in v0.128.0 

func (s *FeatureFlagUserListsService) GetFeatureFlagUserList(pid any, iid int64, options ...RequestOptionFunc) (*FeatureFlagUserList, *Response, error)

GetFeatureFlagUserList gets a feature flag user list.

GitLab API docs: https://docs.gitlab.com/api/feature_flag_user_lists/#get-a-feature-flag-user-list

func (*FeatureFlagUserListsService) ListFeatureFlagUserLists added in v0.128.0 

func (s *FeatureFlagUserListsService) ListFeatureFlagUserLists(pid any, opt *ListFeatureFlagUserListsOptions, options ...RequestOptionFunc) ([]*FeatureFlagUserList, *Response, error)

ListFeatureFlagUserLists gets all feature flag user lists for the requested project.

GitLab API docs: https://docs.gitlab.com/api/feature_flag_user_lists/#list-all-feature-flag-user-lists-for-a-project

func (*FeatureFlagUserListsService) UpdateFeatureFlagUserList added in v0.128.0 

func (s *FeatureFlagUserListsService) UpdateFeatureFlagUserList(pid any, iid int64, opt *UpdateFeatureFlagUserListOptions, options ...RequestOptionFunc) (*FeatureFlagUserList, *Response, error)

UpdateFeatureFlagUserList updates a feature flag user list.

GitLab API docs: https://docs.gitlab.com/api/feature_flag_user_lists/#update-a-feature-flag-user-list

type FeatureFlagUserListsServiceInterface added in v0.128.0 

type FeatureFlagUserListsServiceInterface interface {
	ListFeatureFlagUserLists(pid any, opt *ListFeatureFlagUserListsOptions, options ...RequestOptionFunc) ([]*FeatureFlagUserList, *Response, error)
	CreateFeatureFlagUserList(pid any, opt *CreateFeatureFlagUserListOptions, options ...RequestOptionFunc) (*FeatureFlagUserList, *Response, error)
	GetFeatureFlagUserList(pid any, iid int64, options ...RequestOptionFunc) (*FeatureFlagUserList, *Response, error)
	UpdateFeatureFlagUserList(pid any, iid int64, opt *UpdateFeatureFlagUserListOptions, options ...RequestOptionFunc) (*FeatureFlagUserList, *Response, error)
	DeleteFeatureFlagUserList(pid any, iid int64, options ...RequestOptionFunc) (*Response, error)
}

type FeaturesService added in v0.6.0 

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

FeaturesService handles the communication with the application FeaturesService related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/features/

func (*FeaturesService) DeleteFeatureFlag added in v0.129.0 

func (s *FeaturesService) DeleteFeatureFlag(name string, options ...RequestOptionFunc) (*Response, error)

DeleteFeatureFlag deletes a feature flag.

GitLab API docs: https://docs.gitlab.com/api/features/#delete-a-feature

func (*FeaturesService) ListFeatureDefinitions added in v0.129.0 

func (s *FeaturesService) ListFeatureDefinitions(options ...RequestOptionFunc) ([]*FeatureDefinition, *Response, error)

ListFeatureDefinitions gets a lists of all feature definitions.

GitLab API docs: https://docs.gitlab.com/api/features/#list-all-feature-definitions

func (*FeaturesService) ListFeatures added in v0.6.0 

func (s *FeaturesService) ListFeatures(options ...RequestOptionFunc) ([]*Feature, *Response, error)

ListFeatures gets a list of feature flags

GitLab API docs: https://docs.gitlab.com/api/features/#list-all-features

func (*FeaturesService) SetFeatureFlag added in v0.6.0 

func (s *FeaturesService) SetFeatureFlag(name string, opt *SetFeatureFlagOptions, options ...RequestOptionFunc) (*Feature, *Response, error)

SetFeatureFlag sets or creates a feature flag gate

GitLab API docs: https://docs.gitlab.com/api/features/#set-or-create-a-feature

type FeaturesServiceInterface added in v0.126.0 

type FeaturesServiceInterface interface {
	ListFeatures(options ...RequestOptionFunc) ([]*Feature, *Response, error)
	ListFeatureDefinitions(options ...RequestOptionFunc) ([]*FeatureDefinition, *Response, error)
	SetFeatureFlag(name string, opt *SetFeatureFlagOptions, options ...RequestOptionFunc) (*Feature, *Response, error)
	DeleteFeatureFlag(name string, options ...RequestOptionFunc) (*Response, error)
}

FeaturesServiceInterface defines all the API methods for the FeaturesService

type FetchStats added in v0.153.0 

type FetchStats struct {
	Total int64      `json:"total"`
	Days  []DayStats `json:"days"`
}

type File 

type File struct {
	FileName        string `json:"file_name"`
	FilePath        string `json:"file_path"`
	Size            int64  `json:"size"`
	Encoding        string `json:"encoding"`
	Content         string `json:"content"`
	ExecuteFilemode bool   `json:"execute_filemode"`
	Ref             string `json:"ref"`
	BlobID          string `json:"blob_id"`
	CommitID        string `json:"commit_id"`
	SHA256          string `json:"content_sha256"`
	LastCommitID    string `json:"last_commit_id"`
}

File represents a GitLab repository file.

GitLab API docs: https://docs.gitlab.com/api/repository_files/

func (File) String 

func (r File) String() string

type FileActionValue added in v0.116.0 

type FileActionValue string

FileActionValue represents the available actions that can be performed on a file.

GitLab API docs: https://docs.gitlab.com/api/commits/#create-a-commit-with-multiple-files-and-actions 

const (
	FileCreate FileActionValue = "create"
	FileDelete FileActionValue = "delete"
	FileMove   FileActionValue = "move"
	FileUpdate FileActionValue = "update"
	FileChmod  FileActionValue = "chmod"
)

The available file actions.

type FileBlameRange added in v0.116.0 

type FileBlameRange struct {
	Commit FileBlameRangeCommit `json:"commit"`
	Lines  []string             `json:"lines"`
}

FileBlameRange represents one item of blame information.

GitLab API docs: https://docs.gitlab.com/api/repository_files/#get-file-blame-from-repository

func (FileBlameRange) String added in v0.116.0 

func (b FileBlameRange) String() string

type FileBlameRangeCommit added in v1.0.0 

type FileBlameRangeCommit struct {
	ID             string     `json:"id"`
	ParentIDs      []string   `json:"parent_ids"`
	Message        string     `json:"message"`
	AuthoredDate   *time.Time `json:"authored_date"`
	AuthorName     string     `json:"author_name"`
	AuthorEmail    string     `json:"author_email"`
	CommittedDate  *time.Time `json:"committed_date"`
	CommitterName  string     `json:"committer_name"`
	CommitterEmail string     `json:"committer_email"`
}

FileBlameRangeCommit represents one item of blame information's commit.

GitLab API docs: https://docs.gitlab.com/api/repository_files/#get-file-blame-from-repository

func (FileBlameRangeCommit) String added in v1.0.0 

func (c FileBlameRangeCommit) String() string

type FileInfo 

type FileInfo struct {
	FilePath string `json:"file_path"`
	Branch   string `json:"branch"`
}

FileInfo represents file details of a GitLab repository file.

GitLab API docs: https://docs.gitlab.com/api/repository_files/

func (FileInfo) String 

func (r FileInfo) String() string

type Finding added in v0.116.0 

type Finding struct {
	Confidence          string     `json:"confidence"`
	CreatedAt           *time.Time `json:"created_at"`
	ID                  int64      `json:"id"`
	LocationFingerprint string     `json:"location_fingerprint"`
	MetadataVersion     string     `json:"metadata_version"`
	Name                string     `json:"name"`
	PrimaryIdentifierID int64      `json:"primary_identifier_id"`
	ProjectFingerprint  string     `json:"project_fingerprint"`
	ProjectID           int64      `json:"project_id"`
	RawMetadata         string     `json:"raw_metadata"`
	ReportType          string     `json:"report_type"`
	ScannerID           int64      `json:"scanner_id"`
	Severity            string     `json:"severity"`
	UpdatedAt           *time.Time `json:"updated_at"`
	UUID                string     `json:"uuid"`
	VulnerabilityID     int64      `json:"vulnerability_id"`
}

Finding represents a GitLab project vulnerability finding. Deprecated: use GraphQL Query.vulnerabilities instead

GitLab API docs: https://docs.gitlab.com/api/project_vulnerabilities/

type ForkParent added in v0.6.0 

type ForkParent struct {
	ID                int64  `json:"id"`
	Name              string `json:"name"`
	NameWithNamespace string `json:"name_with_namespace"`
	Path              string `json:"path"`
	PathWithNamespace string `json:"path_with_namespace"`
	HTTPURLToRepo     string `json:"http_url_to_repo"`
	WebURL            string `json:"web_url"`
	RepositoryStorage string `json:"repository_storage"`
}

ForkParent represents the parent project when this is a fork.

type ForkProjectOptions added in v0.116.0 

type ForkProjectOptions struct {
	Branches                      *string          `url:"branches,omitempty" json:"branches,omitempty"`
	Description                   *string          `url:"description,omitempty" json:"description,omitempty"`
	MergeRequestDefaultTargetSelf *bool            `url:"mr_default_target_self,omitempty" json:"mr_default_target_self,omitempty"`
	Name                          *string          `url:"name,omitempty" json:"name,omitempty"`
	NamespaceID                   *int64           `url:"namespace_id,omitempty" json:"namespace_id,omitempty"`
	NamespacePath                 *string          `url:"namespace_path,omitempty" json:"namespace_path,omitempty"`
	Path                          *string          `url:"path,omitempty" json:"path,omitempty"`
	Visibility                    *VisibilityValue `url:"visibility,omitempty" json:"visibility,omitempty"`

	// Deprecated: This parameter has been split into NamespaceID and NamespacePath.
	Namespace *string `url:"namespace,omitempty" json:"namespace,omitempty"`
}

ForkProjectOptions represents the available ForkProject() options.

GitLab API docs: https://docs.gitlab.com/api/project_forks/#fork-a-project

type FreezePeriod added in v0.116.0 

type FreezePeriod struct {
	ID           int64      `json:"id"`
	FreezeStart  string     `json:"freeze_start"`
	FreezeEnd    string     `json:"freeze_end"`
	CronTimezone string     `json:"cron_timezone"`
	CreatedAt    *time.Time `json:"created_at"`
	UpdatedAt    *time.Time `json:"updated_at"`
}

FreezePeriod represents a freeze period object.

GitLab API docs: https://docs.gitlab.com/api/freeze_periods/#list-freeze-periods

type FreezePeriodsService added in v0.116.0 

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

FreezePeriodsService handles the communication with the freeze periods related methods of the GitLab API.

https://docs.gitlab.com/api/freeze_periods/

func (*FreezePeriodsService) CreateFreezePeriodOptions added in v0.116.0 

func (s *FreezePeriodsService) CreateFreezePeriodOptions(pid any, opt *CreateFreezePeriodOptions, options ...RequestOptionFunc) (*FreezePeriod, *Response, error)

CreateFreezePeriodOptions adds a freeze period to a specified project.

GitLab API docs: https://docs.gitlab.com/api/freeze_periods/#create-a-freeze-period

func (*FreezePeriodsService) DeleteFreezePeriod added in v0.116.0 

func (s *FreezePeriodsService) DeleteFreezePeriod(pid any, freezePeriod int64, options ...RequestOptionFunc) (*Response, error)

DeleteFreezePeriod removes a freeze period from a project. This is an idempotent method and can be called multiple times. Either the hook is available or not.

GitLab API docs: https://docs.gitlab.com/api/freeze_periods/#delete-a-freeze-period

func (*FreezePeriodsService) GetFreezePeriod added in v0.116.0 

func (s *FreezePeriodsService) GetFreezePeriod(pid any, freezePeriod int64, options ...RequestOptionFunc) (*FreezePeriod, *Response, error)

GetFreezePeriod gets a specific freeze period for a project.

GitLab API docs: https://docs.gitlab.com/api/freeze_periods/#get-a-freeze-period-by-a-freeze_period_id

func (*FreezePeriodsService) ListFreezePeriods added in v0.116.0 

func (s *FreezePeriodsService) ListFreezePeriods(pid any, opt *ListFreezePeriodsOptions, options ...RequestOptionFunc) ([]*FreezePeriod, *Response, error)

ListFreezePeriods gets a list of project freeze periods.

GitLab API docs: https://docs.gitlab.com/api/freeze_periods/#list-freeze-periods

func (*FreezePeriodsService) UpdateFreezePeriodOptions added in v0.116.0 

func (s *FreezePeriodsService) UpdateFreezePeriodOptions(pid any, freezePeriod int64, opt *UpdateFreezePeriodOptions, options ...RequestOptionFunc) (*FreezePeriod, *Response, error)

UpdateFreezePeriodOptions edits a freeze period for a specified project.

GitLab API docs: https://docs.gitlab.com/api/freeze_periods/#update-a-freeze-period

type FreezePeriodsServiceInterface added in v0.126.0 

type FreezePeriodsServiceInterface interface {
	ListFreezePeriods(pid any, opt *ListFreezePeriodsOptions, options ...RequestOptionFunc) ([]*FreezePeriod, *Response, error)
	GetFreezePeriod(pid any, freezePeriod int64, options ...RequestOptionFunc) (*FreezePeriod, *Response, error)
	CreateFreezePeriodOptions(pid any, opt *CreateFreezePeriodOptions, options ...RequestOptionFunc) (*FreezePeriod, *Response, error)
	UpdateFreezePeriodOptions(pid any, freezePeriod int64, opt *UpdateFreezePeriodOptions, options ...RequestOptionFunc) (*FreezePeriod, *Response, error)
	DeleteFreezePeriod(pid any, freezePeriod int64, options ...RequestOptionFunc) (*Response, error)
}

FreezePeriodsServiceInterface defines all the API methods for the FreezePeriodsService

type GPGKey added in v0.116.0 

type GPGKey struct {
	ID        int64      `json:"id"`
	Key       string     `json:"key"`
	CreatedAt *time.Time `json:"created_at"`
}

GPGKey represents a GPG key.

GitLab API docs: https://docs.gitlab.com/api/user_keys/#list-all-gpg-keys

type GPGSignature added in v0.116.0 

type GPGSignature struct {
	KeyID              int64  `json:"gpg_key_id"`
	KeyPrimaryKeyID    string `json:"gpg_key_primary_keyid"`
	KeyUserName        string `json:"gpg_key_user_name"`
	KeyUserEmail       string `json:"gpg_key_user_email"`
	VerificationStatus string `json:"verification_status"`
	KeySubkeyID        int64  `json:"gpg_key_subkey_id"`
}

GPGSignature represents a GitLab commit's GPG Signature.

GitLab API docs: https://docs.gitlab.com/api/commits/#get-signature-of-a-commit

type Gate added in v0.6.0 

type Gate struct {
	Key   string `json:"key"`
	Value any    `json:"value"`
}

Gate represents a gate of a GitLab feature flag.

GitLab API docs: https://docs.gitlab.com/api/features/

type GenerateChangelogDataOptions added in v0.116.0 

type GenerateChangelogDataOptions struct {
	Version    *string  `url:"version,omitempty" json:"version,omitempty"`
	ConfigFile *string  `url:"config_file,omitempty" json:"config_file,omitempty"`
	Date       *ISOTime `url:"date,omitempty" json:"date,omitempty"`
	From       *string  `url:"from,omitempty" json:"from,omitempty"`
	To         *string  `url:"to,omitempty" json:"to,omitempty"`
	Trailer    *string  `url:"trailer,omitempty" json:"trailer,omitempty"`
}

GenerateChangelogDataOptions represents the available GenerateChangelogData() options.

GitLab API docs: https://docs.gitlab.com/api/repositories/#generate-changelog-data

type GenericGraphQLErrors added in v0.128.0 

type GenericGraphQLErrors struct {
	Errors []struct {
		Message string `json:"message"`
	} `json:"errors"`
}

type GenericPackageSelectValue added in v0.116.0 

type GenericPackageSelectValue string

GenericPackageSelectValue represents a generic package select value. 

const (
	SelectPackageFile GenericPackageSelectValue = "package_file"
)

The available generic package select values.

type GenericPackageStatusValue added in v0.116.0 

type GenericPackageStatusValue string

GenericPackageStatusValue represents a generic package status. 

const (
	PackageDefault GenericPackageStatusValue = "default"
	PackageHidden  GenericPackageStatusValue = "hidden"
)

The available generic package statuses.

type GenericPackagesFile added in v0.116.0 

type GenericPackagesFile struct {
	ID                     int64                  `json:"id"`
	PackageID              int64                  `json:"package_id"`
	CreatedAt              *time.Time             `json:"created_at"`
	UpdatedAt              *time.Time             `json:"updated_at"`
	Size                   int64                  `json:"size"`
	FileStore              int64                  `json:"file_store"`
	FileMD5                string                 `json:"file_md5"`
	FileSHA1               string                 `json:"file_sha1"`
	FileName               string                 `json:"file_name"`
	File                   GenericPackagesFileURL `json:"file"`
	FileSHA256             string                 `json:"file_sha256"`
	VerificationRetryAt    *time.Time             `json:"verification_retry_at"`
	VerifiedAt             *time.Time             `json:"verified_at"`
	VerificationFailure    bool                   `json:"verification_failure"`
	VerificationRetryCount int64                  `json:"verification_retry_count"`
	VerificationChecksum   string                 `json:"verification_checksum"`
	VerificationState      int64                  `json:"verification_state"`
	VerificationStartedAt  *time.Time             `json:"verification_started_at"`
	NewFilePath            string                 `json:"new_file_path"`
}

GenericPackagesFile represents a GitLab generic package file.

GitLab API docs: https://docs.gitlab.com/user/packages/generic_packages/#publish-a-single-file

type GenericPackagesFileURL added in v1.0.0 

type GenericPackagesFileURL struct {
	URL string `json:"url"`
}

GenericPackagesFileURL represents a GitLab generic package file URL.

GitLab API docs: https://docs.gitlab.com/user/packages/generic_packages/#publish-a-single-file

type GenericPackagesService added in v0.116.0 

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

GenericPackagesService handles communication with the packages related methods of the GitLab API.

GitLab docs: https://docs.gitlab.com/user/packages/generic_packages/

func (*GenericPackagesService) DownloadPackageFile added in v0.116.0 

func (s *GenericPackagesService) DownloadPackageFile(pid any, packageName, packageVersion, fileName string, options ...RequestOptionFunc) ([]byte, *Response, error)

DownloadPackageFile allows you to download the package file.

GitLab docs: https://docs.gitlab.com/user/packages/generic_packages/#download-a-single-file

func (*GenericPackagesService) FormatPackageURL added in v0.116.0 

func (s *GenericPackagesService) FormatPackageURL(pid any, packageName, packageVersion, fileName string) (string, error)

FormatPackageURL returns the GitLab Package Registry URL for the given artifact metadata, without the BaseURL. This does not make a GitLab API request, but rather computes it based on their documentation.

func (*GenericPackagesService) PublishPackageFile added in v0.116.0 

func (s *GenericPackagesService) PublishPackageFile(pid any, packageName, packageVersion, fileName string, content io.Reader, opt *PublishPackageFileOptions, options ...RequestOptionFunc) (*GenericPackagesFile, *Response, error)

PublishPackageFile uploads a file to a project's package registry.

GitLab docs: https://docs.gitlab.com/user/packages/generic_packages/#publish-a-single-file

type GenericPackagesServiceInterface added in v0.126.0 

type GenericPackagesServiceInterface interface {
	FormatPackageURL(pid any, packageName, packageVersion, fileName string) (string, error)
	PublishPackageFile(pid any, packageName, packageVersion, fileName string, content io.Reader, opt *PublishPackageFileOptions, options ...RequestOptionFunc) (*GenericPackagesFile, *Response, error)
	DownloadPackageFile(pid any, packageName, packageVersion, fileName string, options ...RequestOptionFunc) ([]byte, *Response, error)
}

GenericPackagesServiceInterface defines all the API methods for the GenericPackagesService

type GeoNode added in v0.116.0 

type GeoNode struct {
	ID                               int64        `json:"id"`
	Name                             string       `json:"name"`
	URL                              string       `json:"url"`
	InternalURL                      string       `json:"internal_url"`
	Primary                          bool         `json:"primary"`
	Enabled                          bool         `json:"enabled"`
	Current                          bool         `json:"current"`
	FilesMaxCapacity                 int64        `json:"files_max_capacity"`
	ReposMaxCapacity                 int64        `json:"repos_max_capacity"`
	VerificationMaxCapacity          int64        `json:"verification_max_capacity"`
	SelectiveSyncType                string       `json:"selective_sync_type"`
	SelectiveSyncShards              []string     `json:"selective_sync_shards"`
	SelectiveSyncNamespaceIDs        []int64      `json:"selective_sync_namespace_ids"`
	MinimumReverificationInterval    int64        `json:"minimum_reverification_interval"`
	ContainerRepositoriesMaxCapacity int64        `json:"container_repositories_max_capacity"`
	SyncObjectStorage                bool         `json:"sync_object_storage"`
	CloneProtocol                    string       `json:"clone_protocol"`
	WebEditURL                       string       `json:"web_edit_url"`
	WebGeoProjectsURL                string       `json:"web_geo_projects_url"`
	Links                            GeoNodeLinks `json:"_links"`
}

GeoNode represents a GitLab Geo Node. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/ 

type GeoNodeLinks struct {
	Self   string `json:"self"`
	Status string `json:"status"`
	Repair string `json:"repair"`
}

GeoNodeLinks represents links for GitLab GeoNode. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/

type GeoNodeStatus added in v0.116.0 

type GeoNodeStatus struct {
	GeoNodeID                                     int64  `json:"geo_node_id"`
	Healthy                                       bool   `json:"healthy"`
	Health                                        string `json:"health"`
	HealthStatus                                  string `json:"health_status"`
	MissingOauthApplication                       bool   `json:"missing_oauth_application"`
	AttachmentsCount                              int64  `json:"attachments_count"`
	AttachmentsSyncedCount                        int64  `json:"attachments_synced_count"`
	AttachmentsFailedCount                        int64  `json:"attachments_failed_count"`
	AttachmentsSyncedMissingOnPrimaryCount        int64  `json:"attachments_synced_missing_on_primary_count"`
	AttachmentsSyncedInPercentage                 string `json:"attachments_synced_in_percentage"`
	DbReplicationLagSeconds                       int64  `json:"db_replication_lag_seconds"`
	LfsObjectsCount                               int64  `json:"lfs_objects_count"`
	LfsObjectsSyncedCount                         int64  `json:"lfs_objects_synced_count"`
	LfsObjectsFailedCount                         int64  `json:"lfs_objects_failed_count"`
	LfsObjectsSyncedMissingOnPrimaryCount         int64  `json:"lfs_objects_synced_missing_on_primary_count"`
	LfsObjectsSyncedInPercentage                  string `json:"lfs_objects_synced_in_percentage"`
	JobArtifactsCount                             int64  `json:"job_artifacts_count"`
	JobArtifactsSyncedCount                       int64  `json:"job_artifacts_synced_count"`
	JobArtifactsFailedCount                       int64  `json:"job_artifacts_failed_count"`
	JobArtifactsSyncedMissingOnPrimaryCount       int64  `json:"job_artifacts_synced_missing_on_primary_count"`
	JobArtifactsSyncedInPercentage                string `json:"job_artifacts_synced_in_percentage"`
	ContainerRepositoriesCount                    int64  `json:"container_repositories_count"`
	ContainerRepositoriesSyncedCount              int64  `json:"container_repositories_synced_count"`
	ContainerRepositoriesFailedCount              int64  `json:"container_repositories_failed_count"`
	ContainerRepositoriesSyncedInPercentage       string `json:"container_repositories_synced_in_percentage"`
	DesignRepositoriesCount                       int64  `json:"design_repositories_count"`
	DesignRepositoriesSyncedCount                 int64  `json:"design_repositories_synced_count"`
	DesignRepositoriesFailedCount                 int64  `json:"design_repositories_failed_count"`
	DesignRepositoriesSyncedInPercentage          string `json:"design_repositories_synced_in_percentage"`
	ProjectsCount                                 int64  `json:"projects_count"`
	RepositoriesCount                             int64  `json:"repositories_count"`
	RepositoriesFailedCount                       int64  `json:"repositories_failed_count"`
	RepositoriesSyncedCount                       int64  `json:"repositories_synced_count"`
	RepositoriesSyncedInPercentage                string `json:"repositories_synced_in_percentage"`
	WikisCount                                    int64  `json:"wikis_count"`
	WikisFailedCount                              int64  `json:"wikis_failed_count"`
	WikisSyncedCount                              int64  `json:"wikis_synced_count"`
	WikisSyncedInPercentage                       string `json:"wikis_synced_in_percentage"`
	ReplicationSlotsCount                         int64  `json:"replication_slots_count"`
	ReplicationSlotsUsedCount                     int64  `json:"replication_slots_used_count"`
	ReplicationSlotsUsedInPercentage              string `json:"replication_slots_used_in_percentage"`
	ReplicationSlotsMaxRetainedWalBytes           int64  `json:"replication_slots_max_retained_wal_bytes"`
	RepositoriesCheckedCount                      int64  `json:"repositories_checked_count"`
	RepositoriesCheckedFailedCount                int64  `json:"repositories_checked_failed_count"`
	RepositoriesCheckedInPercentage               string `json:"repositories_checked_in_percentage"`
	RepositoriesChecksummedCount                  int64  `json:"repositories_checksummed_count"`
	RepositoriesChecksumFailedCount               int64  `json:"repositories_checksum_failed_count"`
	RepositoriesChecksummedInPercentage           string `json:"repositories_checksummed_in_percentage"`
	WikisChecksummedCount                         int64  `json:"wikis_checksummed_count"`
	WikisChecksumFailedCount                      int64  `json:"wikis_checksum_failed_count"`
	WikisChecksummedInPercentage                  string `json:"wikis_checksummed_in_percentage"`
	RepositoriesVerifiedCount                     int64  `json:"repositories_verified_count"`
	RepositoriesVerificationFailedCount           int64  `json:"repositories_verification_failed_count"`
	RepositoriesVerifiedInPercentage              string `json:"repositories_verified_in_percentage"`
	RepositoriesChecksumMismatchCount             int64  `json:"repositories_checksum_mismatch_count"`
	WikisVerifiedCount                            int64  `json:"wikis_verified_count"`
	WikisVerificationFailedCount                  int64  `json:"wikis_verification_failed_count"`
	WikisVerifiedInPercentage                     string `json:"wikis_verified_in_percentage"`
	WikisChecksumMismatchCount                    int64  `json:"wikis_checksum_mismatch_count"`
	RepositoriesRetryingVerificationCount         int64  `json:"repositories_retrying_verification_count"`
	WikisRetryingVerificationCount                int64  `json:"wikis_retrying_verification_count"`
	LastEventID                                   int64  `json:"last_event_id"`
	LastEventTimestamp                            int64  `json:"last_event_timestamp"`
	CursorLastEventID                             int64  `json:"cursor_last_event_id"`
	CursorLastEventTimestamp                      int64  `json:"cursor_last_event_timestamp"`
	LastSuccessfulStatusCheckTimestamp            int64  `json:"last_successful_status_check_timestamp"`
	Version                                       string `json:"version"`
	Revision                                      string `json:"revision"`
	MergeRequestDiffsCount                        int64  `json:"merge_request_diffs_count"`
	MergeRequestDiffsChecksumTotalCount           int64  `json:"merge_request_diffs_checksum_total_count"`
	MergeRequestDiffsChecksummedCount             int64  `json:"merge_request_diffs_checksummed_count"`
	MergeRequestDiffsChecksumFailedCount          int64  `json:"merge_request_diffs_checksum_failed_count"`
	MergeRequestDiffsSyncedCount                  int64  `json:"merge_request_diffs_synced_count"`
	MergeRequestDiffsFailedCount                  int64  `json:"merge_request_diffs_failed_count"`
	MergeRequestDiffsRegistryCount                int64  `json:"merge_request_diffs_registry_count"`
	MergeRequestDiffsVerificationTotalCount       int64  `json:"merge_request_diffs_verification_total_count"`
	MergeRequestDiffsVerifiedCount                int64  `json:"merge_request_diffs_verified_count"`
	MergeRequestDiffsVerificationFailedCount      int64  `json:"merge_request_diffs_verification_failed_count"`
	MergeRequestDiffsSyncedInPercentage           string `json:"merge_request_diffs_synced_in_percentage"`
	MergeRequestDiffsVerifiedInPercentage         string `json:"merge_request_diffs_verified_in_percentage"`
	PackageFilesCount                             int64  `json:"package_files_count"`
	PackageFilesChecksumTotalCount                int64  `json:"package_files_checksum_total_count"`
	PackageFilesChecksummedCount                  int64  `json:"package_files_checksummed_count"`
	PackageFilesChecksumFailedCount               int64  `json:"package_files_checksum_failed_count"`
	PackageFilesSyncedCount                       int64  `json:"package_files_synced_count"`
	PackageFilesFailedCount                       int64  `json:"package_files_failed_count"`
	PackageFilesRegistryCount                     int64  `json:"package_files_registry_count"`
	PackageFilesVerificationTotalCount            int64  `json:"package_files_verification_total_count"`
	PackageFilesVerifiedCount                     int64  `json:"package_files_verified_count"`
	PackageFilesVerificationFailedCount           int64  `json:"package_files_verification_failed_count"`
	PackageFilesSyncedInPercentage                string `json:"package_files_synced_in_percentage"`
	PackageFilesVerifiedInPercentage              string `json:"package_files_verified_in_percentage"`
	PagesDeploymentsCount                         int64  `json:"pages_deployments_count"`
	PagesDeploymentsChecksumTotalCount            int64  `json:"pages_deployments_checksum_total_count"`
	PagesDeploymentsChecksummedCount              int64  `json:"pages_deployments_checksummed_count"`
	PagesDeploymentsChecksumFailedCount           int64  `json:"pages_deployments_checksum_failed_count"`
	PagesDeploymentsSyncedCount                   int64  `json:"pages_deployments_synced_count"`
	PagesDeploymentsFailedCount                   int64  `json:"pages_deployments_failed_count"`
	PagesDeploymentsRegistryCount                 int64  `json:"pages_deployments_registry_count"`
	PagesDeploymentsVerificationTotalCount        int64  `json:"pages_deployments_verification_total_count"`
	PagesDeploymentsVerifiedCount                 int64  `json:"pages_deployments_verified_count"`
	PagesDeploymentsVerificationFailedCount       int64  `json:"pages_deployments_verification_failed_count"`
	PagesDeploymentsSyncedInPercentage            string `json:"pages_deployments_synced_in_percentage"`
	PagesDeploymentsVerifiedInPercentage          string `json:"pages_deployments_verified_in_percentage"`
	TerraformStateVersionsCount                   int64  `json:"terraform_state_versions_count"`
	TerraformStateVersionsChecksumTotalCount      int64  `json:"terraform_state_versions_checksum_total_count"`
	TerraformStateVersionsChecksummedCount        int64  `json:"terraform_state_versions_checksummed_count"`
	TerraformStateVersionsChecksumFailedCount     int64  `json:"terraform_state_versions_checksum_failed_count"`
	TerraformStateVersionsSyncedCount             int64  `json:"terraform_state_versions_synced_count"`
	TerraformStateVersionsFailedCount             int64  `json:"terraform_state_versions_failed_count"`
	TerraformStateVersionsRegistryCount           int64  `json:"terraform_state_versions_registry_count"`
	TerraformStateVersionsVerificationTotalCount  int64  `json:"terraform_state_versions_verification_total_count"`
	TerraformStateVersionsVerifiedCount           int64  `json:"terraform_state_versions_verified_count"`
	TerraformStateVersionsVerificationFailedCount int64  `json:"terraform_state_versions_verification_failed_count"`
	TerraformStateVersionsSyncedInPercentage      string `json:"terraform_state_versions_synced_in_percentage"`
	TerraformStateVersionsVerifiedInPercentage    string `json:"terraform_state_versions_verified_in_percentage"`
	SnippetRepositoriesCount                      int64  `json:"snippet_repositories_count"`
	SnippetRepositoriesChecksumTotalCount         int64  `json:"snippet_repositories_checksum_total_count"`
	SnippetRepositoriesChecksummedCount           int64  `json:"snippet_repositories_checksummed_count"`
	SnippetRepositoriesChecksumFailedCount        int64  `json:"snippet_repositories_checksum_failed_count"`
	SnippetRepositoriesSyncedCount                int64  `json:"snippet_repositories_synced_count"`
	SnippetRepositoriesFailedCount                int64  `json:"snippet_repositories_failed_count"`
	SnippetRepositoriesRegistryCount              int64  `json:"snippet_repositories_registry_count"`
	SnippetRepositoriesVerificationTotalCount     int64  `json:"snippet_repositories_verification_total_count"`
	SnippetRepositoriesVerifiedCount              int64  `json:"snippet_repositories_verified_count"`
	SnippetRepositoriesVerificationFailedCount    int64  `json:"snippet_repositories_verification_failed_count"`
	SnippetRepositoriesSyncedInPercentage         string `json:"snippet_repositories_synced_in_percentage"`
	SnippetRepositoriesVerifiedInPercentage       string `json:"snippet_repositories_verified_in_percentage"`
	GroupWikiRepositoriesCount                    int64  `json:"group_wiki_repositories_count"`
	GroupWikiRepositoriesChecksumTotalCount       int64  `json:"group_wiki_repositories_checksum_total_count"`
	GroupWikiRepositoriesChecksummedCount         int64  `json:"group_wiki_repositories_checksummed_count"`
	GroupWikiRepositoriesChecksumFailedCount      int64  `json:"group_wiki_repositories_checksum_failed_count"`
	GroupWikiRepositoriesSyncedCount              int64  `json:"group_wiki_repositories_synced_count"`
	GroupWikiRepositoriesFailedCount              int64  `json:"group_wiki_repositories_failed_count"`
	GroupWikiRepositoriesRegistryCount            int64  `json:"group_wiki_repositories_registry_count"`
	GroupWikiRepositoriesVerificationTotalCount   int64  `json:"group_wiki_repositories_verification_total_count"`
	GroupWikiRepositoriesVerifiedCount            int64  `json:"group_wiki_repositories_verified_count"`
	GroupWikiRepositoriesVerificationFailedCount  int64  `json:"group_wiki_repositories_verification_failed_count"`
	GroupWikiRepositoriesSyncedInPercentage       string `json:"group_wiki_repositories_synced_in_percentage"`
	GroupWikiRepositoriesVerifiedInPercentage     string `json:"group_wiki_repositories_verified_in_percentage"`
	PipelineArtifactsCount                        int64  `json:"pipeline_artifacts_count"`
	PipelineArtifactsChecksumTotalCount           int64  `json:"pipeline_artifacts_checksum_total_count"`
	PipelineArtifactsChecksummedCount             int64  `json:"pipeline_artifacts_checksummed_count"`
	PipelineArtifactsChecksumFailedCount          int64  `json:"pipeline_artifacts_checksum_failed_count"`
	PipelineArtifactsSyncedCount                  int64  `json:"pipeline_artifacts_synced_count"`
	PipelineArtifactsFailedCount                  int64  `json:"pipeline_artifacts_failed_count"`
	PipelineArtifactsRegistryCount                int64  `json:"pipeline_artifacts_registry_count"`
	PipelineArtifactsVerificationTotalCount       int64  `json:"pipeline_artifacts_verification_total_count"`
	PipelineArtifactsVerifiedCount                int64  `json:"pipeline_artifacts_verified_count"`
	PipelineArtifactsVerificationFailedCount      int64  `json:"pipeline_artifacts_verification_failed_count"`
	PipelineArtifactsSyncedInPercentage           string `json:"pipeline_artifacts_synced_in_percentage"`
	PipelineArtifactsVerifiedInPercentage         string `json:"pipeline_artifacts_verified_in_percentage"`
	UploadsCount                                  int64  `json:"uploads_count"`
	UploadsSyncedCount                            int64  `json:"uploads_synced_count"`
	UploadsFailedCount                            int64  `json:"uploads_failed_count"`
	UploadsRegistryCount                          int64  `json:"uploads_registry_count"`
	UploadsSyncedInPercentage                     string `json:"uploads_synced_in_percentage"`
}

GeoNodeStatus represents the status of Geo Node. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#retrieve-status-about-all-geo-nodes

type GeoNodesService added in v0.116.0 

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

GeoNodesService handles communication with Geo Nodes related methods of GitLab API. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/

func (*GeoNodesService) CreateGeoNode added in v0.116.0 

func (s *GeoNodesService) CreateGeoNode(opt *CreateGeoNodesOptions, options ...RequestOptionFunc) (*GeoNode, *Response, error)

CreateGeoNode creates a new Geo Node. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#create-a-new-geo-node

func (*GeoNodesService) DeleteGeoNode added in v0.116.0 

func (s *GeoNodesService) DeleteGeoNode(id int64, options ...RequestOptionFunc) (*Response, error)

DeleteGeoNode removes the Geo node. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#delete-a-geo-node

func (*GeoNodesService) EditGeoNode added in v0.116.0 

func (s *GeoNodesService) EditGeoNode(id int64, opt *UpdateGeoNodesOptions, options ...RequestOptionFunc) (*GeoNode, *Response, error)

EditGeoNode updates settings of an existing Geo node. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#edit-a-geo-node

func (*GeoNodesService) GetGeoNode added in v0.116.0 

func (s *GeoNodesService) GetGeoNode(id int64, options ...RequestOptionFunc) (*GeoNode, *Response, error)

GetGeoNode gets a specific geo node. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#retrieve-configuration-about-a-specific-geo-node

func (*GeoNodesService) ListGeoNodes added in v0.116.0 

func (s *GeoNodesService) ListGeoNodes(opt *ListGeoNodesOptions, options ...RequestOptionFunc) ([]*GeoNode, *Response, error)

ListGeoNodes gets a list of geo nodes. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#retrieve-configuration-about-all-geo-nodes

func (*GeoNodesService) RepairGeoNode added in v0.116.0 

func (s *GeoNodesService) RepairGeoNode(id int64, options ...RequestOptionFunc) (*GeoNode, *Response, error)

RepairGeoNode to repair the OAuth authentication of a Geo node. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#repair-a-geo-node

func (*GeoNodesService) RetrieveStatusOfAllGeoNodes added in v0.116.0 

func (s *GeoNodesService) RetrieveStatusOfAllGeoNodes(options ...RequestOptionFunc) ([]*GeoNodeStatus, *Response, error)

RetrieveStatusOfAllGeoNodes get the list of status of all Geo Nodes. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#retrieve-status-about-all-geo-nodes

func (*GeoNodesService) RetrieveStatusOfGeoNode added in v0.116.0 

func (s *GeoNodesService) RetrieveStatusOfGeoNode(id int64, options ...RequestOptionFunc) (*GeoNodeStatus, *Response, error)

RetrieveStatusOfGeoNode get the of status of a specific Geo Nodes. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#retrieve-status-about-a-specific-geo-node

type GeoNodesServiceInterface deprecated added in v0.126.0 

type GeoNodesServiceInterface interface {
	// Deprecated: will be removed in v5 of the API, use Geo Sites API instead
	CreateGeoNode(*CreateGeoNodesOptions, ...RequestOptionFunc) (*GeoNode, *Response, error)
	// Deprecated: will be removed in v5 of the API, use Geo Sites API instead
	ListGeoNodes(*ListGeoNodesOptions, ...RequestOptionFunc) ([]*GeoNode, *Response, error)
	// Deprecated: will be removed in v5 of the API, use Geo Sites API instead
	GetGeoNode(int64, ...RequestOptionFunc) (*GeoNode, *Response, error)
	// Deprecated: will be removed in v5 of the API, use Geo Sites API instead
	EditGeoNode(int64, *UpdateGeoNodesOptions, ...RequestOptionFunc) (*GeoNode, *Response, error)
	// Deprecated: will be removed in v5 of the API, use Geo Sites API instead
	DeleteGeoNode(int64, ...RequestOptionFunc) (*Response, error)
	// Deprecated: will be removed in v5 of the API, use Geo Sites API instead
	RepairGeoNode(int64, ...RequestOptionFunc) (*GeoNode, *Response, error)
	// Deprecated: will be removed in v5 of the API, use Geo Sites API instead
	RetrieveStatusOfAllGeoNodes(...RequestOptionFunc) ([]*GeoNodeStatus, *Response, error)
	// Deprecated: will be removed in v5 of the API, use Geo Sites API instead
	RetrieveStatusOfGeoNode(int64, ...RequestOptionFunc) (*GeoNodeStatus, *Response, error)
}

Deprecated: will be removed in v5 of the API, use Geo Sites API instead

type GeoSite added in v0.128.0 

type GeoSite struct {
	ID                               int64        `json:"id"`
	Name                             string       `json:"name"`
	URL                              string       `json:"url"`
	InternalURL                      string       `json:"internal_url"`
	Primary                          bool         `json:"primary"`
	Enabled                          bool         `json:"enabled"`
	Current                          bool         `json:"current"`
	FilesMaxCapacity                 int64        `json:"files_max_capacity"`
	ReposMaxCapacity                 int64        `json:"repos_max_capacity"`
	VerificationMaxCapacity          int64        `json:"verification_max_capacity"`
	ContainerRepositoriesMaxCapacity int64        `json:"container_repositories_max_capacity"`
	SelectiveSyncType                string       `json:"selective_sync_type"`
	SelectiveSyncShards              []string     `json:"selective_sync_shards"`
	SelectiveSyncNamespaceIDs        []int64      `json:"selective_sync_namespace_ids"`
	MinimumReverificationInterval    int64        `json:"minimum_reverification_interval"`
	SyncObjectStorage                bool         `json:"sync_object_storage"`
	WebEditURL                       string       `json:"web_edit_url"`
	WebGeoReplicationDetailsURL      string       `json:"web_geo_replication_details_url"`
	Links                            GeoSiteLinks `json:"_links"`
}

GeoSite represents a GitLab Geo Site.

GitLab API docs: https://docs.gitlab.com/api/geo_sites/ 

type GeoSiteLinks struct {
	Self   string `json:"self"`
	Status string `json:"status"`
	Repair string `json:"repair"`
}

GeoSiteLinks represents links for GitLab GeoSite.

GitLab API docs: https://docs.gitlab.com/api/geo_sites/

type GeoSiteStatus added in v0.128.0 

type GeoSiteStatus struct {
	GeoNodeID                                       int64             `json:"geo_node_id"`
	ProjectsCount                                   int64             `json:"projects_count"`
	ContainerRepositoriesReplicationEnabled         bool              `json:"container_repositories_replication_enabled"`
	LFSObjectsCount                                 int64             `json:"lfs_objects_count"`
	LFSObjectsChecksumTotalCount                    int64             `json:"lfs_objects_checksum_total_count"`
	LFSObjectsChecksummedCount                      int64             `json:"lfs_objects_checksummed_count"`
	LFSObjectsChecksumFailedCount                   int64             `json:"lfs_objects_checksum_failed_count"`
	LFSObjectsSyncedCount                           int64             `json:"lfs_objects_synced_count"`
	LFSObjectsFailedCount                           int64             `json:"lfs_objects_failed_count"`
	LFSObjectsRegistryCount                         int64             `json:"lfs_objects_registry_count"`
	LFSObjectsVerificationTotalCount                int64             `json:"lfs_objects_verification_total_count"`
	LFSObjectsVerifiedCount                         int64             `json:"lfs_objects_verified_count"`
	LFSObjectsVerificationFailedCount               int64             `json:"lfs_objects_verification_failed_count"`
	MergeRequestDiffsCount                          int64             `json:"merge_request_diffs_count"`
	MergeRequestDiffsChecksumTotalCount             int64             `json:"merge_request_diffs_checksum_total_count"`
	MergeRequestDiffsChecksummedCount               int64             `json:"merge_request_diffs_checksummed_count"`
	MergeRequestDiffsChecksumFailedCount            int64             `json:"merge_request_diffs_checksum_failed_count"`
	MergeRequestDiffsSyncedCount                    int64             `json:"merge_request_diffs_synced_count"`
	MergeRequestDiffsFailedCount                    int64             `json:"merge_request_diffs_failed_count"`
	MergeRequestDiffsRegistryCount                  int64             `json:"merge_request_diffs_registry_count"`
	MergeRequestDiffsVerificationTotalCount         int64             `json:"merge_request_diffs_verification_total_count"`
	MergeRequestDiffsVerifiedCount                  int64             `json:"merge_request_diffs_verified_count"`
	MergeRequestDiffsVerificationFailedCount        int64             `json:"merge_request_diffs_verification_failed_count"`
	PackageFilesCount                               int64             `json:"package_files_count"`
	PackageFilesChecksumTotalCount                  int64             `json:"package_files_checksum_total_count"`
	PackageFilesChecksummedCount                    int64             `json:"package_files_checksummed_count"`
	PackageFilesChecksumFailedCount                 int64             `json:"package_files_checksum_failed_count"`
	PackageFilesSyncedCount                         int64             `json:"package_files_synced_count"`
	PackageFilesFailedCount                         int64             `json:"package_files_failed_count"`
	PackageFilesRegistryCount                       int64             `json:"package_files_registry_count"`
	PackageFilesVerificationTotalCount              int64             `json:"package_files_verification_total_count"`
	PackageFilesVerifiedCount                       int64             `json:"package_files_verified_count"`
	PackageFilesVerificationFailedCount             int64             `json:"package_files_verification_failed_count"`
	TerraformStateVersionsCount                     int64             `json:"terraform_state_versions_count"`
	TerraformStateVersionsChecksumTotalCount        int64             `json:"terraform_state_versions_checksum_total_count"`
	TerraformStateVersionsChecksummedCount          int64             `json:"terraform_state_versions_checksummed_count"`
	TerraformStateVersionsChecksumFailedCount       int64             `json:"terraform_state_versions_checksum_failed_count"`
	TerraformStateVersionsSyncedCount               int64             `json:"terraform_state_versions_synced_count"`
	TerraformStateVersionsFailedCount               int64             `json:"terraform_state_versions_failed_count"`
	TerraformStateVersionsRegistryCount             int64             `json:"terraform_state_versions_registry_count"`
	TerraformStateVersionsVerificationTotalCount    int64             `json:"terraform_state_versions_verification_total_count"`
	TerraformStateVersionsVerifiedCount             int64             `json:"terraform_state_versions_verified_count"`
	TerraformStateVersionsVerificationFailedCount   int64             `json:"terraform_state_versions_verification_failed_count"`
	SnippetRepositoriesCount                        int64             `json:"snippet_repositories_count"`
	SnippetRepositoriesChecksumTotalCount           int64             `json:"snippet_repositories_checksum_total_count"`
	SnippetRepositoriesChecksummedCount             int64             `json:"snippet_repositories_checksummed_count"`
	SnippetRepositoriesChecksumFailedCount          int64             `json:"snippet_repositories_checksum_failed_count"`
	SnippetRepositoriesSyncedCount                  int64             `json:"snippet_repositories_synced_count"`
	SnippetRepositoriesFailedCount                  int64             `json:"snippet_repositories_failed_count"`
	SnippetRepositoriesRegistryCount                int64             `json:"snippet_repositories_registry_count"`
	SnippetRepositoriesVerificationTotalCount       int64             `json:"snippet_repositories_verification_total_count"`
	SnippetRepositoriesVerifiedCount                int64             `json:"snippet_repositories_verified_count"`
	SnippetRepositoriesVerificationFailedCount      int64             `json:"snippet_repositories_verification_failed_count"`
	GroupWikiRepositoriesCount                      int64             `json:"group_wiki_repositories_count"`
	GroupWikiRepositoriesChecksumTotalCount         int64             `json:"group_wiki_repositories_checksum_total_count"`
	GroupWikiRepositoriesChecksummedCount           int64             `json:"group_wiki_repositories_checksummed_count"`
	GroupWikiRepositoriesChecksumFailedCount        int64             `json:"group_wiki_repositories_checksum_failed_count"`
	GroupWikiRepositoriesSyncedCount                int64             `json:"group_wiki_repositories_synced_count"`
	GroupWikiRepositoriesFailedCount                int64             `json:"group_wiki_repositories_failed_count"`
	GroupWikiRepositoriesRegistryCount              int64             `json:"group_wiki_repositories_registry_count"`
	GrupWikiRepositoriesVerificationTotalCount      int64             `json:"group_wiki_repositories_verification_total_count"`
	GroupWikiRepositoriesVerifiedCount              int64             `json:"group_wiki_repositories_verified_count"`
	GroupWikiRepositoriesVerificationFailedCount    int64             `json:"group_wiki_repositories_verification_failed_count"`
	PipelineArtifactsCount                          int64             `json:"pipeline_artifacts_count"`
	PipelineArtifactsChecksumTotalCount             int64             `json:"pipeline_artifacts_checksum_total_count"`
	PipelineArtifactsChecksummedCount               int64             `json:"pipeline_artifacts_checksummed_count"`
	PipelineArtifactsChecksumFailedCount            int64             `json:"pipeline_artifacts_checksum_failed_count"`
	PipelineArtifactsSyncedCount                    int64             `json:"pipeline_artifacts_synced_count"`
	PipelineArtifactsFailedCount                    int64             `json:"pipeline_artifacts_failed_count"`
	PipelineArtifactsRegistryCount                  int64             `json:"pipeline_artifacts_registry_count"`
	PipelineArtifactsVerificationTotalCount         int64             `json:"pipeline_artifacts_verification_total_count"`
	PipelineArtifactsVerifiedCount                  int64             `json:"pipeline_artifacts_verified_count"`
	PipelineArtifactsVerificationFailedCount        int64             `json:"pipeline_artifacts_verification_failed_count"`
	PagesDeploymentsCount                           int64             `json:"pages_deployments_count"`
	PagesDeploymentsChecksumTotalCount              int64             `json:"pages_deployments_checksum_total_count"`
	PagesDeploymentsChecksummedCount                int64             `json:"pages_deployments_checksummed_count"`
	PagesDeploymentsChecksumFailedCount             int64             `json:"pages_deployments_checksum_failed_count"`
	PagesDeploymentsSyncedCount                     int64             `json:"pages_deployments_synced_count"`
	PagesDeploymentsFailedCount                     int64             `json:"pages_deployments_failed_count"`
	PagesDeploymentsRegistryCount                   int64             `json:"pages_deployments_registry_count"`
	PagesDeploymentsVerificationTotalCount          int64             `json:"pages_deployments_verification_total_count"`
	PagesDeploymentsVerifiedCount                   int64             `json:"pages_deployments_verified_count"`
	PagesDeploymentsVerificationFailedCount         int64             `json:"pages_deployments_verification_failed_count"`
	UploadsCount                                    int64             `json:"uploads_count"`
	UploadsChecksumTotalCount                       int64             `json:"uploads_checksum_total_count"`
	UploadsChecksummedCount                         int64             `json:"uploads_checksummed_count"`
	UploadsChecksumFailedCount                      int64             `json:"uploads_checksum_failed_count"`
	UploadsSyncedCount                              int64             `json:"uploads_synced_count"`
	UploadsFailedCount                              int64             `json:"uploads_failed_count"`
	UploadsRegistryCount                            int64             `json:"uploads_registry_count"`
	UploadsVerificationTotalCount                   int64             `json:"uploads_verification_total_count"`
	UploadsVerifiedCount                            int64             `json:"uploads_verified_count"`
	UploadsVerificationFailedCount                  int64             `json:"uploads_verification_failed_count"`
	JobArtifactsCount                               int64             `json:"job_artifacts_count"`
	JobArtifactsChecksumTotalCount                  int64             `json:"job_artifacts_checksum_total_count"`
	JobArtifactsChecksummedCount                    int64             `json:"job_artifacts_checksummed_count"`
	JobArtifactsChecksumFailedCount                 int64             `json:"job_artifacts_checksum_failed_count"`
	JobArtifactsSyncedCount                         int64             `json:"job_artifacts_synced_count"`
	JobArtifactsFailedCount                         int64             `json:"job_artifacts_failed_count"`
	JobArtifactsRegistryCount                       int64             `json:"job_artifacts_registry_count"`
	JobArtifactsVerificationTotalCount              int64             `json:"job_artifacts_verification_total_count"`
	JobArtifactsVerifiedCount                       int64             `json:"job_artifacts_verified_count"`
	JobArtifactsVerificationFailedCount             int64             `json:"job_artifacts_verification_failed_count"`
	CISecureFilesCount                              int64             `json:"ci_secure_files_count"`
	CISecureFilesChecksumTotalCount                 int64             `json:"ci_secure_files_checksum_total_count"`
	CISecureFilesChecksummedCount                   int64             `json:"ci_secure_files_checksummed_count"`
	CISecureFilesChecksumFailedCount                int64             `json:"ci_secure_files_checksum_failed_count"`
	CISecureFilesSyncedCount                        int64             `json:"ci_secure_files_synced_count"`
	CISecureFilesFailedCount                        int64             `json:"ci_secure_files_failed_count"`
	CISecureFilesRegistryCount                      int64             `json:"ci_secure_files_registry_count"`
	CISecureFilesVerificationTotalCount             int64             `json:"ci_secure_files_verification_total_count"`
	CISecureFilesVerifiedCount                      int64             `json:"ci_secure_files_verified_count"`
	CISecureFilesVerificationFailedCount            int64             `json:"ci_secure_files_verification_failed_count"`
	ContainerRepositoriesCount                      int64             `json:"container_repositories_count"`
	ContainerRepositoriesChecksumTotalCount         int64             `json:"container_repositories_checksum_total_count"`
	ContainerRepositoriesChecksummedCount           int64             `json:"container_repositories_checksummed_count"`
	ContainerRepositoriesChecksumFailedCount        int64             `json:"container_repositories_checksum_failed_count"`
	ContainerRepositoriesSyncedCount                int64             `json:"container_repositories_synced_count"`
	ContainerRepositoriesFailedCount                int64             `json:"container_repositories_failed_count"`
	ContainerRepositoriesRegistryCount              int64             `json:"container_repositories_registry_count"`
	ContainerRepositoriesVerificationTotalCount     int64             `json:"container_repositories_verification_total_count"`
	ContainerRepositoriesVerifiedCount              int64             `json:"container_repositories_verified_count"`
	ContainerRepositoriesVerificationFailedCount    int64             `json:"container_repositories_verification_failed_count"`
	DependencyProxyBlobsCount                       int64             `json:"dependency_proxy_blobs_count"`
	DependencyProxyBlobsChecksumTotalCount          int64             `json:"dependency_proxy_blobs_checksum_total_count"`
	DependencyProxyBlobsChecksummedCount            int64             `json:"dependency_proxy_blobs_checksummed_count"`
	DependencyProxyBlobsChecksumFailedCount         int64             `json:"dependency_proxy_blobs_checksum_failed_count"`
	DependencyProxyBlobsSyncedCount                 int64             `json:"dependency_proxy_blobs_synced_count"`
	DependencyProxyBlobsFailedCount                 int64             `json:"dependency_proxy_blobs_failed_count"`
	DependencyProxyBlobsRegistryCount               int64             `json:"dependency_proxy_blobs_registry_count"`
	DependencyProxyBlobsVerificationTotalCount      int64             `json:"dependency_proxy_blobs_verification_total_count"`
	DependencyProxyBlobsVerifiedCount               int64             `json:"dependency_proxy_blobs_verified_count"`
	DependencyProxyBlobsVerificationFailedCount     int64             `json:"dependency_proxy_blobs_verification_failed_count"`
	DependencyProxyManifestsCount                   int64             `json:"dependency_proxy_manifests_count"`
	DependencyProxyManifestsChecksumTotalCount      int64             `json:"dependency_proxy_manifests_checksum_total_count"`
	DependencyProxyManifestsChecksummedCount        int64             `json:"dependency_proxy_manifests_checksummed_count"`
	DependencyProxyManifestsChecksumFailedCount     int64             `json:"dependency_proxy_manifests_checksum_failed_count"`
	DependencyProxyManifestsSyncedCount             int64             `json:"dependency_proxy_manifests_synced_count"`
	DependencyProxyManifestsFailedCount             int64             `json:"dependency_proxy_manifests_failed_count"`
	DependencyProxyManifestsRegistryCount           int64             `json:"dependency_proxy_manifests_registry_count"`
	DependencyProxyManifestsVerificationTotalCount  int64             `json:"dependency_proxy_manifests_verification_total_count"`
	DependencyProxyManifestsVerifiedCount           int64             `json:"dependency_proxy_manifests_verified_count"`
	DependencyProxyManifestsVerificationFailedCount int64             `json:"dependency_proxy_manifests_verification_failed_count"`
	ProjectWikiRepositoriesCount                    int64             `json:"project_wiki_repositories_count"`
	ProjectWikiRepositoriesChecksumTotalCount       int64             `json:"project_wiki_repositories_checksum_total_count"`
	ProjectWikiRepositoriesChecksummedCount         int64             `json:"project_wiki_repositories_checksummed_count"`
	ProjectWikiRepositoriesChecksumFailedCount      int64             `json:"project_wiki_repositories_checksum_failed_count"`
	ProjectWikiRepositoriesSyncedCount              int64             `json:"project_wiki_repositories_synced_count"`
	ProjectWikiRepositoriesFailedCount              int64             `json:"project_wiki_repositories_failed_count"`
	ProjectWikiRepositoriesRegistryCount            int64             `json:"project_wiki_repositories_registry_count"`
	ProjectWikiRepositoriesVerificationTotalCount   int64             `json:"project_wiki_repositories_verification_total_count"`
	ProjectWikiRepositoriesVerifiedCount            int64             `json:"project_wiki_repositories_verified_count"`
	ProjectWikiRepositoriesVerificationFailedCount  int64             `json:"project_wiki_repositories_verification_failed_count"`
	GitFetchEventCountWeekly                        int64             `json:"git_fetch_event_count_weekly"`
	GitPushEventCountWeekly                         int64             `json:"git_push_event_count_weekly"`
	ProxyRemoteRequestsEventCountWeekly             int64             `json:"proxy_remote_requests_event_count_weekly"`
	ProxyLocalRequestsEventCountWeekly              int64             `json:"proxy_local_requests_event_count_weekly"`
	RepositoriesCheckedInPercentage                 string            `json:"repositories_checked_in_percentage"`
	ReplicationSlotsUsedInPercentage                string            `json:"replication_slots_used_in_percentage"`
	LFSObjectsSyncedInPercentage                    string            `json:"lfs_objects_synced_in_percentage"`
	LFSObjectsVerifiedInPercentage                  string            `json:"lfs_objects_verified_in_percentage"`
	MergeRequestDiffsSyncedInPercentage             string            `json:"merge_request_diffs_synced_in_percentage"`
	MergeRequestDiffsVerifiedInPercentage           string            `json:"merge_request_diffs_verified_in_percentage"`
	PackageFilesSyncedInPercentage                  string            `json:"package_files_synced_in_percentage"`
	PackageFilesVerifiedInPercentage                string            `json:"package_files_verified_in_percentage"`
	TerraformStateVersionsSyncedInPercentage        string            `json:"terraform_state_versions_synced_in_percentage"`
	TerraformStateVersionsVerifiedInPercentage      string            `json:"terraform_state_versions_verified_in_percentage"`
	SnippetRepositoriesSyncedInPercentage           string            `json:"snippet_repositories_synced_in_percentage"`
	SnippetRepositoriesVerifiedInPercentage         string            `json:"snippet_repositories_verified_in_percentage"`
	GroupWikiRepositoriesSyncedInPercentage         string            `json:"group_wiki_repositories_synced_in_percentage"`
	GroupWikiRepositoriesVerifiedInPercentage       string            `json:"group_wiki_repositories_verified_in_percentage"`
	PipelineArtifactsSyncedInPercentage             string            `json:"pipeline_artifacts_synced_in_percentage"`
	PipelineArtifactsVerifiedInPercentage           string            `json:"pipeline_artifacts_verified_in_percentage"`
	PagesDeploymentsSyncedInPercentage              string            `json:"pages_deployments_synced_in_percentage"`
	PagesDeploymentsVerifiedInPercentage            string            `json:"pages_deployments_verified_in_percentage"`
	UploadsSyncedInPercentage                       string            `json:"uploads_synced_in_percentage"`
	UploadsVerifiedInPercentage                     string            `json:"uploads_verified_in_percentage"`
	JobArtifactsSyncedInPercentage                  string            `json:"job_artifacts_synced_in_percentage"`
	JobArtifactsVerifiedInPercentage                string            `json:"job_artifacts_verified_in_percentage"`
	CISecureFilesSyncedInPercentage                 string            `json:"ci_secure_files_synced_in_percentage"`
	CISecureFilesVerifiedInPercentage               string            `json:"ci_secure_files_verified_in_percentage"`
	ContainerRepositoriesSyncedInPercentage         string            `json:"container_repositories_synced_in_percentage"`
	ContainerRepositoriesVerifiedInPercentage       string            `json:"container_repositories_verified_in_percentage"`
	DependencyProxyBlobsSyncedInPercentage          string            `json:"dependency_proxy_blobs_synced_in_percentage"`
	DependencyProxyBlobsVerifiedInPercentage        string            `json:"dependency_proxy_blobs_verified_in_percentage"`
	DependencyProxyManifestsSyncedInPercentage      string            `json:"dependency_proxy_manifests_synced_in_percentage"`
	DependencyProxyManifestsVerifiedInPercentage    string            `json:"dependency_proxy_manifests_verified_in_percentage"`
	ProjectWikiRepositoriesSyncedInPercentage       string            `json:"project_wiki_repositories_synced_in_percentage"`
	ProjectWikiRepositoriesVerifiedInPercentage     string            `json:"project_wiki_repositories_verified_in_percentage"`
	ReplicationSlotsCount                           int64             `json:"replication_slots_count"`
	ReplicationSlotsUsedCount                       int64             `json:"replication_slots_used_count"`
	Healthy                                         bool              `json:"healthy"`
	Health                                          string            `json:"health"`
	HealthStatus                                    string            `json:"health_status"`
	MissingOAuthApplication                         bool              `json:"missing_oauth_application"`
	DBReplicationLagSeconds                         int64             `json:"db_replication_lag_seconds"`
	ReplicationSlotsMaxRetainedWalBytes             int64             `json:"replication_slots_max_retained_wal_bytes"`
	RepositoriesCheckedCount                        int64             `json:"repositories_checked_count"`
	RepositoriesCheckedFailedCount                  int64             `json:"repositories_checked_failed_count"`
	LastEventID                                     int64             `json:"last_event_id"`
	LastEventTimestamp                              int64             `json:"last_event_timestamp"`
	CursorLastEventID                               int64             `json:"cursor_last_event_id"`
	CursorLastEventTimestamp                        int64             `json:"cursor_last_event_timestamp"`
	LastSuccessfulStatusCheckTimestamp              int64             `json:"last_successful_status_check_timestamp"`
	Version                                         string            `json:"version"`
	Revision                                        string            `json:"revision"`
	SelectiveSyncType                               string            `json:"selective_sync_type"`
	Namespaces                                      []string          `json:"namespaces"`
	UpdatedAt                                       time.Time         `json:"updated_at"`
	StorageShardsMatch                              bool              `json:"storage_shards_match"`
	Links                                           GeoSiteStatusLink `json:"_links"`
}

GeoSiteStatus represents the status of Geo Site.

GitLab API docs: https://docs.gitlab.com/api/geo_sites/#list-all-geo-site-statuses 

type GeoSiteStatusLink struct {
	Self string `json:"self"`
	Site string `json:"site"`
}

GeoSiteStatusLink represents the links for a GitLab Geo Site status.

GitLab API docs: https://docs.gitlab.com/api/geo_sites/#list-all-geo-site-statuses

type GeoSitesService added in v0.128.0 

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

GeoSitesService handles communication with Geo Sites related methods of GitLab API.

GitLab API docs: https://docs.gitlab.com/api/geo_sites/

func (*GeoSitesService) CreateGeoSite added in v0.128.0 

func (s *GeoSitesService) CreateGeoSite(opt *CreateGeoSitesOptions, options ...RequestOptionFunc) (*GeoSite, *Response, error)

func (*GeoSitesService) DeleteGeoSite added in v0.128.0 

func (s *GeoSitesService) DeleteGeoSite(id int64, options ...RequestOptionFunc) (*Response, error)

func (*GeoSitesService) EditGeoSite added in v0.128.0 

func (s *GeoSitesService) EditGeoSite(id int64, opt *EditGeoSiteOptions, options ...RequestOptionFunc) (*GeoSite, *Response, error)

func (*GeoSitesService) GetGeoSite added in v0.128.0 

func (s *GeoSitesService) GetGeoSite(id int64, options ...RequestOptionFunc) (*GeoSite, *Response, error)

func (*GeoSitesService) GetStatusOfGeoSite added in v0.128.0 

func (s *GeoSitesService) GetStatusOfGeoSite(id int64, options ...RequestOptionFunc) (*GeoSiteStatus, *Response, error)

func (*GeoSitesService) ListGeoSites added in v0.128.0 

func (s *GeoSitesService) ListGeoSites(opt *ListGeoSitesOptions, options ...RequestOptionFunc) ([]*GeoSite, *Response, error)

func (*GeoSitesService) ListStatusOfAllGeoSites added in v0.128.0 

func (s *GeoSitesService) ListStatusOfAllGeoSites(opt *ListStatusOfAllGeoSitesOptions, options ...RequestOptionFunc) ([]*GeoSiteStatus, *Response, error)

func (*GeoSitesService) RepairGeoSite added in v0.128.0 

func (s *GeoSitesService) RepairGeoSite(id int64, options ...RequestOptionFunc) (*GeoSite, *Response, error)

type GeoSitesServiceInterface added in v0.128.0 

type GeoSitesServiceInterface interface {
	// CreateGeoSite creates a new Geo Site.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/geo_sites/#create-a-new-geo-site
	CreateGeoSite(*CreateGeoSitesOptions, ...RequestOptionFunc) (*GeoSite, *Response, error)
	// ListGeoSites gets a list of geo sites.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/geo_sites/#retrieve-configuration-about-all-geo-sites
	ListGeoSites(*ListGeoSitesOptions, ...RequestOptionFunc) ([]*GeoSite, *Response, error)
	// GetGeoSite gets a specific geo site.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/geo_sites/#retrieve-configuration-about-a-specific-geo-site
	GetGeoSite(int64, ...RequestOptionFunc) (*GeoSite, *Response, error)
	// EditGeoSite updates settings of an existing Geo site.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/geo_sites/#edit-a-geo-site
	EditGeoSite(int64, *EditGeoSiteOptions, ...RequestOptionFunc) (*GeoSite, *Response, error)
	// DeleteGeoSite removes the Geo site.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/geo_sites/#delete-a-geo-site
	DeleteGeoSite(int64, ...RequestOptionFunc) (*Response, error)
	// RepairGeoSite to repair the OAuth authentication of a Geo site.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/geo_sites/#repair-a-geo-site
	RepairGeoSite(int64, ...RequestOptionFunc) (*GeoSite, *Response, error)
	// ListStatusOfAllGeoSites get the list of status of all Geo Sites.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/geo_sites/#retrieve-status-about-all-geo-sites
	ListStatusOfAllGeoSites(*ListStatusOfAllGeoSitesOptions, ...RequestOptionFunc) ([]*GeoSiteStatus, *Response, error)
	// GetStatusOfGeoSite gets the status of a specific Geo Site.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/geo_sites/#retrieve-status-about-a-specific-geo-site
	GetStatusOfGeoSite(int64, ...RequestOptionFunc) (*GeoSiteStatus, *Response, error)
}

type GetAllImpersonationTokensOptions added in v0.6.0 

type GetAllImpersonationTokensOptions struct {
	ListOptions
	State *string `url:"state,omitempty" json:"state,omitempty"`
}

GetAllImpersonationTokensOptions represents the available GetAllImpersonationTokens() options.

GitLab API docs: https://docs.gitlab.com/api/user_tokens/#list-all-impersonation-tokens-for-a-user

type GetAvatarOptions added in v0.116.0 

type GetAvatarOptions struct {
	Email *string `url:"email,omitempty" json:"email,omitempty"`
	Size  *int64  `url:"size,omitempty" json:"size,omitempty"`
}

GetAvatarOptions represents the available GetAvatar() options.

GitLab API docs: https://docs.gitlab.com/api/avatar/#get-details-on-an-account-avatar

type GetCommitCommentsOptions added in v0.8.1 

type GetCommitCommentsOptions struct {
	ListOptions
}

GetCommitCommentsOptions represents the available GetCommitComments() options.

GitLab API docs: https://docs.gitlab.com/api/commits/#get-the-comments-of-a-commit

type GetCommitDiffOptions added in v0.8.1 

type GetCommitDiffOptions struct {
	ListOptions
	Unidiff *bool `url:"unidiff,omitempty" json:"unidiff,omitempty"`
}

GetCommitDiffOptions represents the available GetCommitDiff() options.

GitLab API docs: https://docs.gitlab.com/api/commits/#get-the-diff-of-a-commit

type GetCommitOptions added in v0.116.0 

type GetCommitOptions struct {
	Stats *bool `url:"stats,omitempty" json:"stats,omitempty"`
}

GetCommitOptions represents the available GetCommit() options.

GitLab API docs: https://docs.gitlab.com/api/commits/#get-a-single-commit

type GetCommitRefsOptions added in v0.10.8 

type GetCommitRefsOptions struct {
	ListOptions
	Type *string `url:"type,omitempty" json:"type,omitempty"`
}

GetCommitRefsOptions represents the available GetCommitRefs() options.

GitLab API docs: https://docs.gitlab.com/api/commits/#get-references-a-commit-is-pushed-to

type GetCommitStatusesOptions 

type GetCommitStatusesOptions struct {
	ListOptions
	Ref        *string `url:"ref,omitempty" json:"ref,omitempty"`
	Stage      *string `url:"stage,omitempty" json:"stage,omitempty"`
	Name       *string `url:"name,omitempty" json:"name,omitempty"`
	PipelineID *int64  `url:"pipeline_id,omitempty" json:"pipeline_id,omitempty"`
	All        *bool   `url:"all,omitempty" json:"all,omitempty"`
}

GetCommitStatusesOptions represents the available GetCommitStatuses() options.

GitLab API docs: https://docs.gitlab.com/api/commits/#list-the-statuses-of-a-commit

type GetCurrentPlanLimitsOptions added in v0.116.0 

type GetCurrentPlanLimitsOptions struct {
	PlanName *string `url:"plan_name,omitempty" json:"plan_name,omitempty"`
}

GetCurrentPlanLimitsOptions represents the available GetCurrentPlanLimits() options.

GitLab API docs: https://docs.gitlab.com/api/plan_limits/#get-current-plan-limits

type GetDORAMetricsOptions added in v0.116.0 

type GetDORAMetricsOptions struct {
	Metric           *DORAMetricType     `url:"metric,omitempty" json:"metric,omitempty"`
	EndDate          *ISOTime            `url:"end_date,omitempty" json:"end_date,omitempty"`
	EnvironmentTiers *[]string           `url:"environment_tiers,comma,omitempty" json:"environment_tiers,omitempty"`
	Interval         *DORAMetricInterval `url:"interval,omitempty" json:"interval,omitempty"`
	StartDate        *ISOTime            `url:"start_date,omitempty" json:"start_date,omitempty"`
}

GetDORAMetricsOptions represent the request body options for getting DORA metrics

GitLab API docs: https://docs.gitlab.com/api/dora/metrics/

type GetFileBlameOptions added in v0.116.0 

type GetFileBlameOptions struct {
	Ref        *string `url:"ref,omitempty" json:"ref,omitempty"`
	RangeStart *int64  `url:"range[start],omitempty" json:"range[start],omitempty"`
	RangeEnd   *int64  `url:"range[end],omitempty" json:"range[end],omitempty"`
}

GetFileBlameOptions represents the available GetFileBlame() options.

GitLab API docs: https://docs.gitlab.com/api/repository_files/#get-file-blame-from-repository

type GetFileMetaDataOptions added in v0.116.0 

type GetFileMetaDataOptions struct {
	Ref *string `url:"ref,omitempty" json:"ref,omitempty"`
}

GetFileMetaDataOptions represents the available GetFileMetaData() options.

GitLab API docs: https://docs.gitlab.com/api/repository_files/#get-file-from-repository

type GetFileOptions 

type GetFileOptions struct {
	Ref *string `url:"ref,omitempty" json:"ref,omitempty"`
}

GetFileOptions represents the available GetFile() options.

GitLab API docs: https://docs.gitlab.com/api/repository_files/#get-file-from-repository

type GetGroupIssuesStatisticsOptions added in v0.116.0 

type GetGroupIssuesStatisticsOptions struct {
	Labels           *LabelOptions `url:"labels,omitempty" json:"labels,omitempty"`
	IIDs             *[]int64      `url:"iids[],omitempty" json:"iids,omitempty"`
	Milestone        *string       `url:"milestone,omitempty" json:"milestone,omitempty"`
	Scope            *string       `url:"scope,omitempty" json:"scope,omitempty"`
	AuthorID         *int64        `url:"author_id,omitempty" json:"author_id,omitempty"`
	AuthorUsername   *string       `url:"author_username,omitempty" json:"author_username,omitempty"`
	AssigneeID       *int64        `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	AssigneeUsername *[]string     `url:"assignee_username,omitempty" json:"assignee_username,omitempty"`
	MyReactionEmoji  *string       `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
	Search           *string       `url:"search,omitempty" json:"search,omitempty"`
	CreatedAfter     *time.Time    `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore    *time.Time    `url:"created_before,omitempty" json:"created_before,omitempty"`
	UpdatedAfter     *time.Time    `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore    *time.Time    `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	Confidential     *bool         `url:"confidential,omitempty" json:"confidential,omitempty"`
}

GetGroupIssuesStatisticsOptions represents the available GetGroupIssuesStatistics() options.

GitLab API docs: https://docs.gitlab.com/api/issues_statistics/#get-group-issues-statistics

type GetGroupMilestoneBurndownChartEventsOptions added in v0.116.0 

type GetGroupMilestoneBurndownChartEventsOptions struct {
	ListOptions
}

GetGroupMilestoneBurndownChartEventsOptions represents the available GetGroupMilestoneBurndownChartEventsOptions() options.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#get-all-burndown-chart-events-for-a-single-milestone

type GetGroupMilestoneIssuesOptions added in v0.10.0 

type GetGroupMilestoneIssuesOptions struct {
	ListOptions
}

GetGroupMilestoneIssuesOptions represents the available GetGroupMilestoneIssues() options.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#get-all-issues-assigned-to-a-single-milestone

type GetGroupMilestoneMergeRequestsOptions added in v0.10.0 

type GetGroupMilestoneMergeRequestsOptions struct {
	ListOptions
}

GetGroupMilestoneMergeRequestsOptions represents the available GetGroupMilestoneMergeRequests() options.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#get-all-merge-requests-assigned-to-a-single-milestone

type GetGroupOptions added in v0.116.0 

type GetGroupOptions struct {
	ListOptions
	WithCustomAttributes *bool `url:"with_custom_attributes,omitempty" json:"with_custom_attributes,omitempty"`

	// Deprecated: will be removed in v5 of the API, use ListGroupProjects instead
	WithProjects *bool `url:"with_projects,omitempty" json:"with_projects,omitempty"`
}

GetGroupOptions represents the available GetGroup() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#get-a-single-group

type GetGroupVariableOptions added in v0.116.0 

type GetGroupVariableOptions struct {
	Filter *VariableFilter `url:"filter,omitempty" json:"filter,omitempty"`
}

GetGroupVariableOptions represents the available GetVariable() options.

GitLab API docs: https://docs.gitlab.com/api/group_level_variables/#show-variable-details

type GetGroupWikiPageOptions added in v0.116.0 

type GetGroupWikiPageOptions struct {
	RenderHTML *bool   `url:"render_html,omitempty" json:"render_html,omitempty"`
	Version    *string `url:"version,omitempty" json:"version,omitempty"`
}

GetGroupWikiPageOptions represents options to GetGroupWikiPage

GitLab API docs: https://docs.gitlab.com/api/group_wikis/#get-a-wiki-page

type GetIssueBoardListsOptions added in v0.8.1 

type GetIssueBoardListsOptions struct {
	ListOptions
}

GetIssueBoardListsOptions represents the available GetIssueBoardLists() options.

GitLab API docs: https://docs.gitlab.com/api/boards/#list-board-lists-in-a-project-issue-board

type GetIssuesClosedOnMergeOptions added in v0.8.1 

type GetIssuesClosedOnMergeOptions struct {
	ListOptions
}

GetIssuesClosedOnMergeOptions represents the available GetIssuesClosedOnMerge() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-issues-that-close-on-merge

type GetIssuesStatisticsOptions added in v0.116.0 

type GetIssuesStatisticsOptions struct {
	Labels           *LabelOptions `url:"labels,omitempty" json:"labels,omitempty"`
	Milestone        *string       `url:"milestone,omitempty" json:"milestone,omitempty"`
	Scope            *string       `url:"scope,omitempty" json:"scope,omitempty"`
	AuthorID         *int64        `url:"author_id,omitempty" json:"author_id,omitempty"`
	AuthorUsername   *string       `url:"author_username,omitempty" json:"author_username,omitempty"`
	AssigneeID       *int64        `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	AssigneeUsername *[]string     `url:"assignee_username,omitempty" json:"assignee_username,omitempty"`
	MyReactionEmoji  *string       `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
	IIDs             *[]int64      `url:"iids[],omitempty" json:"iids,omitempty"`
	Search           *string       `url:"search,omitempty" json:"search,omitempty"`
	In               *string       `url:"in,omitempty" json:"in,omitempty"`
	CreatedAfter     *time.Time    `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore    *time.Time    `url:"created_before,omitempty" json:"created_before,omitempty"`
	UpdatedAfter     *time.Time    `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore    *time.Time    `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	Confidential     *bool         `url:"confidential,omitempty" json:"confidential,omitempty"`
}

GetIssuesStatisticsOptions represents the available GetIssuesStatistics() options.

GitLab API docs: https://docs.gitlab.com/api/issues_statistics/#get-issues-statistics

type GetJobTokenAllowlistGroupsOptions added in v0.116.0 

type GetJobTokenAllowlistGroupsOptions struct {
	ListOptions
}

GetJobTokenAllowlistGroupsOptions represents the available GetJobTokenAllowlistGroups() options.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#get-a-projects-cicd-job-token-allowlist-of-groups

type GetJobTokenInboundAllowListOptions added in v0.116.0 

type GetJobTokenInboundAllowListOptions struct {
	ListOptions
}

GetJobTokenInboundAllowListOptions represents the available GetJobTokenInboundAllowList() options.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#get-a-projects-cicd-job-token-inbound-allowlist

type GetJobTokensJobOptions added in v0.116.0 

type GetJobTokensJobOptions struct {
	JobToken *string `url:"job_token,omitempty" json:"job_token,omitempty"`
}

GetJobTokensJobOptions represents the available GetJobTokensJob() options.

GitLab API docs: https://docs.gitlab.com/api/jobs/#get-job-tokens-job

type GetKeyByFingerprintOptions added in v0.116.0 

type GetKeyByFingerprintOptions struct {
	Fingerprint string `url:"fingerprint" json:"fingerprint"`
}

GetKeyByFingerprintOptions represents the available GetKeyByFingerprint() options.

GitLab API docs: https://docs.gitlab.com/api/keys/#get-user-by-fingerprint-of-ssh-key https://docs.gitlab.com/api/keys/#get-user-by-deploy-key-fingerprint

type GetLatestPipelineOptions added in v0.116.0 

type GetLatestPipelineOptions struct {
	Ref *string `url:"ref,omitempty" json:"ref,omitempty"`
}

GetLatestPipelineOptions represents the available GetLatestPipeline() options.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#get-the-latest-pipeline

type GetLicenseTemplateOptions added in v0.11.1 

type GetLicenseTemplateOptions struct {
	Project  *string `url:"project,omitempty" json:"project,omitempty"`
	Fullname *string `url:"fullname,omitempty" json:"fullname,omitempty"`
}

GetLicenseTemplateOptions represents the available GetLicenseTemplate() options.

GitLab API docs: https://docs.gitlab.com/api/templates/licenses/#single-license-template

type GetMergeRequestChangesOptions added in v0.116.0 

type GetMergeRequestChangesOptions struct {
	AccessRawDiffs *bool `url:"access_raw_diffs,omitempty" json:"access_raw_diffs,omitempty"`
	Unidiff        *bool `url:"unidiff,omitempty" json:"unidiff,omitempty"`
}

GetMergeRequestChangesOptions represents the available GetMergeRequestChanges() options. Deprecated: This endpoint has been replaced by MergeRequestsService.ListMergeRequestDiffs()

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-single-merge-request-changes

type GetMergeRequestCommitsOptions added in v0.8.1 

type GetMergeRequestCommitsOptions struct {
	ListOptions
}

GetMergeRequestCommitsOptions represents the available GetMergeRequestCommits() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-single-merge-request-commits

type GetMergeRequestDiffVersionsOptions added in v0.8.1 

type GetMergeRequestDiffVersionsOptions struct {
	ListOptions
}

GetMergeRequestDiffVersionsOptions represents the available GetMergeRequestDiffVersions() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-merge-request-diff-versions

type GetMergeRequestsOptions added in v0.116.0 

type GetMergeRequestsOptions struct {
	RenderHTML                  *bool `url:"render_html,omitempty" json:"render_html,omitempty"`
	IncludeDivergedCommitsCount *bool `url:"include_diverged_commits_count,omitempty" json:"include_diverged_commits_count,omitempty"`
	IncludeRebaseInProgress     *bool `url:"include_rebase_in_progress,omitempty" json:"include_rebase_in_progress,omitempty"`
}

GetMergeRequestsOptions represents the available GetMergeRequests() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-single-mr

type GetMilestoneIssuesOptions 

type GetMilestoneIssuesOptions struct {
	ListOptions
}

GetMilestoneIssuesOptions represents the available GetMilestoneIssues() options.

GitLab API docs: https://docs.gitlab.com/api/milestones/#get-all-issues-assigned-to-a-single-milestone

type GetMilestoneMergeRequestsOptions added in v0.10.0 

type GetMilestoneMergeRequestsOptions struct {
	ListOptions
}

GetMilestoneMergeRequestsOptions represents the available GetMilestoneMergeRequests() options.

GitLab API docs: https://docs.gitlab.com/api/milestones/#get-all-merge-requests-assigned-to-a-single-milestone

type GetProjectApprovalRulesListsOptions added in v0.116.0 

type GetProjectApprovalRulesListsOptions struct {
	ListOptions
}

GetProjectApprovalRulesListsOptions represents the available GetProjectApprovalRules() options.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#get-all-approval-rules-for-project

type GetProjectIssuesStatisticsOptions added in v0.116.0 

type GetProjectIssuesStatisticsOptions struct {
	IIDs             *[]int64      `url:"iids[],omitempty" json:"iids,omitempty"`
	Labels           *LabelOptions `url:"labels,omitempty" json:"labels,omitempty"`
	Milestone        *string       `url:"milestone,omitempty" json:"milestone,omitempty"`
	Scope            *string       `url:"scope,omitempty" json:"scope,omitempty"`
	AuthorID         *int64        `url:"author_id,omitempty" json:"author_id,omitempty"`
	AuthorUsername   *string       `url:"author_username,omitempty" json:"author_username,omitempty"`
	AssigneeID       *int64        `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	AssigneeUsername *[]string     `url:"assignee_username,omitempty" json:"assignee_username,omitempty"`
	MyReactionEmoji  *string       `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
	Search           *string       `url:"search,omitempty" json:"search,omitempty"`
	CreatedAfter     *time.Time    `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore    *time.Time    `url:"created_before,omitempty" json:"created_before,omitempty"`
	UpdatedAfter     *time.Time    `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore    *time.Time    `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	Confidential     *bool         `url:"confidential,omitempty" json:"confidential,omitempty"`
}

GetProjectIssuesStatisticsOptions represents the available GetProjectIssuesStatistics() options.

GitLab API docs: https://docs.gitlab.com/api/issues_statistics/#get-project-issues-statistics

type GetProjectOptions added in v0.116.0 

type GetProjectOptions struct {
	License              *bool `url:"license,omitempty" json:"license,omitempty"`
	Statistics           *bool `url:"statistics,omitempty" json:"statistics,omitempty"`
	WithCustomAttributes *bool `url:"with_custom_attributes,omitempty" json:"with_custom_attributes,omitempty"`
}

GetProjectOptions represents the available GetProject() options.

GitLab API docs: https://docs.gitlab.com/api/projects/#get-a-single-project

type GetProjectVariableOptions added in v0.116.0 

type GetProjectVariableOptions struct {
	Filter *VariableFilter `url:"filter,omitempty" json:"filter,omitempty"`
}

GetProjectVariableOptions represents the available GetVariable() options.

GitLab API docs: https://docs.gitlab.com/api/project_level_variables/#get-a-single-variable

type GetRawFileOptions added in v0.6.0 

type GetRawFileOptions struct {
	Ref *string `url:"ref,omitempty" json:"ref,omitempty"`
	LFS *bool   `url:"lfs,omitempty" json:"lfs,omitempty"`
}

GetRawFileOptions represents the available GetRawFile() options.

GitLab API docs: https://docs.gitlab.com/api/repository_files/#get-raw-file-from-repository

type GetRecentlyAddedMembersCountOptions added in v0.128.0 

type GetRecentlyAddedMembersCountOptions struct {
	GroupPath string `url:"group_path" json:"group_path"`
}

GetRecentlyAddedMembersCountOptions represents the available GetRecentlyAddedMembersCount() options.

GitLab API docs: https://docs.gitlab.com/api/group_activity_analytics/#get-count-of-members-recently-added-to-group

type GetRecentlyCreatedIssuesCountOptions added in v0.128.0 

type GetRecentlyCreatedIssuesCountOptions struct {
	GroupPath string `url:"group_path" json:"group_path"`
}

GetRecentlyCreatedIssuesCountOptions represents the available GetRecentlyCreatedIssuesCount() options.

GitLab API docs: https://docs.gitlab.com/api/group_activity_analytics/#get-count-of-recently-created-issues-for-group

type GetRecentlyCreatedMergeRequestsCountOptions added in v0.128.0 

type GetRecentlyCreatedMergeRequestsCountOptions struct {
	GroupPath string `url:"group_path" json:"group_path"`
}

GetRecentlyCreatedMergeRequestsCountOptions represents the available GetRecentlyCreatedMergeRequestsCount() options.

GitLab API docs: https://docs.gitlab.com/api/group_activity_analytics/#get-count-of-recently-created-merge-requests-for-group

type GetSingleMergeRequestDiffVersionOptions added in v0.116.0 

type GetSingleMergeRequestDiffVersionOptions struct {
	Unidiff *bool `url:"unidiff,omitempty" json:"unidiff,omitempty"`
}

GetSingleMergeRequestDiffVersionOptions represents the available GetSingleMergeRequestDiffVersion() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-a-single-merge-request-diff-version

type GetSingleRegistryRepositoryOptions added in v0.116.0 

type GetSingleRegistryRepositoryOptions struct {
	Tags      *bool `url:"tags,omitempty" json:"tags,omitempty"`
	TagsCount *bool `url:"tags_count,omitempty" json:"tags_count,omitempty"`
}

GetSingleRegistryRepositoryOptions represents the available GetSingleRegistryRepository() options.

GitLab API docs: https://docs.gitlab.com/api/container_registry/#get-details-of-a-single-repository

type GetUserActivitiesOptions added in v0.7.4 

type GetUserActivitiesOptions struct {
	ListOptions
	From *ISOTime `url:"from,omitempty" json:"from,omitempty"`
}

GetUserActivitiesOptions represents the options for GetUserActivities

GitLab API docs: https://docs.gitlab.com/api/users/#list-a-users-activity

type GetUserMembershipOptions added in v0.116.0 

type GetUserMembershipOptions struct {
	ListOptions
	Type *string `url:"type,omitempty" json:"type,omitempty"`
}

GetUserMembershipOptions represents the options available to query user memberships.

GitLab API docs: https://docs.gitlab.com/api/users/#list-projects-and-groups-that-a-user-is-a-member-of

type GetUsersOptions added in v0.116.0 

type GetUsersOptions struct {
	WithCustomAttributes *bool `url:"with_custom_attributes,omitempty" json:"with_custom_attributes,omitempty"`
}

GetUsersOptions represents the available GetUser() options.

GitLab API docs: https://docs.gitlab.com/api/users/#get-a-single-user

type GetWikiPageOptions added in v0.116.0 

type GetWikiPageOptions struct {
	RenderHTML *bool   `url:"render_html,omitempty" json:"render_html,omitempty"`
	Version    *string `url:"version,omitempty" json:"version,omitempty"`
}

GetWikiPageOptions represents options to GetWikiPage

GitLab API docs: https://docs.gitlab.com/api/wikis/#get-a-wiki-page

type GitHubImport added in v0.116.0 

type GitHubImport struct {
	ID                    int64  `json:"id"`
	Name                  string `json:"name"`
	FullPath              string `json:"full_path"`
	FullName              string `json:"full_name"`
	RefsURL               string `json:"refs_url"`
	ImportSource          string `json:"import_source"`
	ImportStatus          string `json:"import_status"`
	HumanImportStatusName string `json:"human_import_status_name"`
	ProviderLink          string `json:"provider_link"`
	RelationType          string `json:"relation_type"`
	ImportWarning         string `json:"import_warning"`
}

GitHubImport represents the response from an import from GitHub.

GitLab API docs: https://docs.gitlab.com/api/import/#import-repository-from-github

func (GitHubImport) String added in v0.116.0 

func (s GitHubImport) String() string

type GitIgnoreTemplate added in v0.9.0 

type GitIgnoreTemplate struct {
	Name    string `json:"name"`
	Content string `json:"content"`
}

GitIgnoreTemplate represents a GitLab gitignore template.

GitLab API docs: https://docs.gitlab.com/api/templates/gitignores/

type GitIgnoreTemplateListItem added in v0.116.0 

type GitIgnoreTemplateListItem struct {
	Key  string `json:"key"`
	Name string `json:"name"`
}

GitIgnoreTemplateListItem represents a GitLab gitignore template from the list.

GitLab API docs: https://docs.gitlab.com/api/templates/gitignores/

type GitIgnoreTemplatesService added in v0.9.0 

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

GitIgnoreTemplatesService handles communication with the gitignore templates related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/templates/gitignores/

func (*GitIgnoreTemplatesService) GetTemplate added in v0.9.0 

func (s *GitIgnoreTemplatesService) GetTemplate(key string, options ...RequestOptionFunc) (*GitIgnoreTemplate, *Response, error)

GetTemplate get a git ignore template

GitLab API docs: https://docs.gitlab.com/api/templates/gitignores/#get-a-single-gitignore-template

func (*GitIgnoreTemplatesService) ListTemplates added in v0.9.0 

func (s *GitIgnoreTemplatesService) ListTemplates(opt *ListTemplatesOptions, options ...RequestOptionFunc) ([]*GitIgnoreTemplateListItem, *Response, error)

ListTemplates get a list of available git ignore templates

GitLab API docs: https://docs.gitlab.com/api/templates/gitignores/#get-all-gitignore-templates

type GitIgnoreTemplatesServiceInterface added in v0.126.0 

type GitIgnoreTemplatesServiceInterface interface {
	ListTemplates(*ListTemplatesOptions, ...RequestOptionFunc) ([]*GitIgnoreTemplateListItem, *Response, error)
	GetTemplate(string, ...RequestOptionFunc) (*GitIgnoreTemplate, *Response, error)
}

GitIgnoreTemplatesServiceInterface defines all the API methods for the GitIgnoreTemplatesService

type GithubService added in v0.116.0 

type GithubService struct {
	Service
	Properties *GithubServiceProperties `json:"properties"`
}

GithubService represents Github service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#github

type GithubServiceProperties added in v0.116.0 

type GithubServiceProperties struct {
	RepositoryURL string `json:"repository_url"`
	StaticContext bool   `json:"static_context"`
}

GithubServiceProperties represents Github specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#github

type GoogleChatIntegration added in v1.19.0 

type GoogleChatIntegration struct {
	Integration
	Properties GoogleChatIntegrationProperties `json:"properties"`
}

GoogleChatIntegration represents the Google Chat integration settings.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#google-chat

type GoogleChatIntegrationProperties added in v1.19.0 

type GoogleChatIntegrationProperties struct {
	NotifyOnlyBrokenPipelines           bool   `json:"notify_only_broken_pipelines,omitempty"`
	NotifyOnlyWhenPipelineStatusChanges bool   `json:"notify_only_when_pipeline_status_changes,omitempty"`
	NotifyOnlyDefaultBranch             bool   `json:"notify_only_default_branch,omitempty"`
	BranchesToBeNotified                string `json:"branches_to_be_notified,omitempty"`
	PushEvents                          bool   `json:"push_events,omitempty"`
	IssuesEvents                        bool   `json:"issues_events,omitempty"`
	ConfidentialIssuesEvents            bool   `json:"confidential_issues_events,omitempty"`
	MergeRequestsEvents                 bool   `json:"merge_requests_events,omitempty"`
	TagPushEvents                       bool   `json:"tag_push_events,omitempty"`
	NoteEvents                          bool   `json:"note_events,omitempty"`
	ConfidentialNoteEvents              bool   `json:"confidential_note_events,omitempty"`
	PipelineEvents                      bool   `json:"pipeline_events,omitempty"`
	WikiPageEvents                      bool   `json:"wiki_page_events,omitempty"`
}

GoogleChatIntegrationProperties represents Google Chat specific properties.

type GraphQL added in v0.128.0 

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

func (*GraphQL) Do added in v0.128.0 

func (g *GraphQL) Do(query GraphQLQuery, response any, options ...RequestOptionFunc) (*Response, error)

Do sends a GraphQL query and returns the response in the given response argument The response must be JSON serializable. The *Response return value is the HTTP response and must be used to retrieve additional HTTP information, like status codes and also error messages from failed queries.

Example: 

var response struct {
	Data struct {
		Project struct {
			ID string `json:"id"`
		} `json:"project"`
	} `json:"data"`
}
_, err := client.GraphQL.Do(GraphQLQuery{Query: `query { project(fullPath: "gitlab-org/gitlab") { id } }`}, &response, gitlab.WithContext(ctx))

Attention: This API is experimental and may be subject to breaking changes to improve the API in the future.

type GraphQLInterface added in v0.128.0 

type GraphQLInterface interface {
	Do(query GraphQLQuery, response any, options ...RequestOptionFunc) (*Response, error)
}

type GraphQLQuery added in v0.128.0 

type GraphQLQuery struct {
	Query     string         `json:"query"`
	Variables map[string]any `json:"variables,omitempty"`
}

type GraphQLResponseError added in v0.128.0 

type GraphQLResponseError struct {
	Err    error
	Errors GenericGraphQLErrors
}

func (*GraphQLResponseError) Error added in v0.128.0 

func (e *GraphQLResponseError) Error() string

type Group 

type Group struct {
	ID                              int64                      `json:"id"`
	Name                            string                     `json:"name"`
	Path                            string                     `json:"path"`
	Description                     string                     `json:"description"`
	MembershipLock                  bool                       `json:"membership_lock"`
	Visibility                      VisibilityValue            `json:"visibility"`
	LFSEnabled                      bool                       `json:"lfs_enabled"`
	MaxArtifactsSize                int64                      `json:"max_artifacts_size"`
	DefaultBranch                   string                     `json:"default_branch"`
	DefaultBranchProtectionDefaults *BranchProtectionDefaults  `json:"default_branch_protection_defaults"`
	AvatarURL                       string                     `json:"avatar_url"`
	WebURL                          string                     `json:"web_url"`
	RequestAccessEnabled            bool                       `json:"request_access_enabled"`
	RepositoryStorage               string                     `json:"repository_storage"`
	FullName                        string                     `json:"full_name"`
	FullPath                        string                     `json:"full_path"`
	FileTemplateProjectID           int64                      `json:"file_template_project_id"`
	ParentID                        int64                      `json:"parent_id"`
	Statistics                      *Statistics                `json:"statistics"`
	CustomAttributes                []*CustomAttribute         `json:"custom_attributes"`
	ShareWithGroupLock              bool                       `json:"share_with_group_lock"`
	RequireTwoFactorAuth            bool                       `json:"require_two_factor_authentication"`
	TwoFactorGracePeriod            int64                      `json:"two_factor_grace_period"`
	ProjectCreationLevel            ProjectCreationLevelValue  `json:"project_creation_level"`
	AutoDevopsEnabled               bool                       `json:"auto_devops_enabled"`
	SubGroupCreationLevel           SubGroupCreationLevelValue `json:"subgroup_creation_level"`
	EmailsEnabled                   bool                       `json:"emails_enabled"`
	MentionsDisabled                bool                       `json:"mentions_disabled"`
	RunnersToken                    string                     `json:"runners_token"`
	SharedRunnersSetting            SharedRunnersSettingValue  `json:"shared_runners_setting"`
	SharedWithGroups                []SharedWithGroup          `json:"shared_with_groups"`
	LDAPCN                          string                     `json:"ldap_cn"`
	LDAPAccess                      AccessLevelValue           `json:"ldap_access"`
	LDAPGroupLinks                  []*LDAPGroupLink           `json:"ldap_group_links"`
	SAMLGroupLinks                  []*SAMLGroupLink           `json:"saml_group_links"`
	SharedRunnersMinutesLimit       int64                      `json:"shared_runners_minutes_limit"`
	ExtraSharedRunnersMinutesLimit  int64                      `json:"extra_shared_runners_minutes_limit"`
	PreventForkingOutsideGroup      bool                       `json:"prevent_forking_outside_group"`
	MarkedForDeletionOn             *ISOTime                   `json:"marked_for_deletion_on"`
	CreatedAt                       *time.Time                 `json:"created_at"`
	IPRestrictionRanges             string                     `json:"ip_restriction_ranges"`
	AllowedEmailDomainsList         string                     `json:"allowed_email_domains_list"`
	WikiAccessLevel                 AccessControlValue         `json:"wiki_access_level"`

	OnlyAllowMergeIfPipelineSucceeds          bool `json:"only_allow_merge_if_pipeline_succeeds"`
	AllowMergeOnSkippedPipeline               bool `json:"allow_merge_on_skipped_pipeline"`
	OnlyAllowMergeIfAllDiscussionsAreResolved bool `json:"only_allow_merge_if_all_discussions_are_resolved"`

	// Deprecated: will be removed in v5 of the API, use ListGroupProjects instead
	Projects []*Project `json:"projects"`

	// Deprecated: will be removed in v5 of the API, use ListGroupSharedProjects instead
	SharedProjects []*Project `json:"shared_projects"`

	// Deprecated: Use EmailsEnabled instead
	EmailsDisabled bool `json:"emails_disabled"`

	// Deprecated: Use DefaultBranchProtectionDefaults instead
	DefaultBranchProtection int64 `json:"default_branch_protection"`
}

Group represents a GitLab group.

GitLab API docs: https://docs.gitlab.com/api/groups/

type GroupAccess 

type GroupAccess struct {
	AccessLevel       AccessLevelValue       `json:"access_level"`
	NotificationLevel NotificationLevelValue `json:"notification_level"`
}

GroupAccess represents group access.

type GroupAccessLevel added in v0.116.0 

type GroupAccessLevel struct {
	AccessLevel *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
}

GroupAccessLevel represents default branch protection defaults access levels.

GitLab API docs: https://docs.gitlab.com/api/groups/#options-for-default_branch_protection_defaults

type GroupAccessToken added in v0.116.0 

type GroupAccessToken resourceAccessToken

GroupAccessToken represents a GitLab group access token.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/

func (GroupAccessToken) String added in v0.116.0 

func (v GroupAccessToken) String() string

type GroupAccessTokensService added in v0.116.0 

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

GroupAccessTokensService handles communication with the groups access tokens related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/

func (*GroupAccessTokensService) CreateGroupAccessToken added in v0.116.0 

func (s *GroupAccessTokensService) CreateGroupAccessToken(gid any, opt *CreateGroupAccessTokenOptions, options ...RequestOptionFunc) (*GroupAccessToken, *Response, error)

CreateGroupAccessToken creates a new group access token.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#create-a-group-access-token

func (*GroupAccessTokensService) GetGroupAccessToken added in v0.116.0 

func (s *GroupAccessTokensService) GetGroupAccessToken(gid any, id int64, options ...RequestOptionFunc) (*GroupAccessToken, *Response, error)

GetGroupAccessToken gets a single group access tokens in a group.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#get-details-on-a-group-access-token

func (*GroupAccessTokensService) ListGroupAccessTokens added in v0.116.0 

func (s *GroupAccessTokensService) ListGroupAccessTokens(gid any, opt *ListGroupAccessTokensOptions, options ...RequestOptionFunc) ([]*GroupAccessToken, *Response, error)

ListGroupAccessTokens gets a list of all group access tokens in a group.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#list-all-group-access-tokens

func (*GroupAccessTokensService) RevokeGroupAccessToken added in v0.116.0 

func (s *GroupAccessTokensService) RevokeGroupAccessToken(gid any, id int64, options ...RequestOptionFunc) (*Response, error)

RevokeGroupAccessToken revokes a group access token.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#revoke-a-group-access-token

func (*GroupAccessTokensService) RotateGroupAccessToken added in v0.116.0 

func (s *GroupAccessTokensService) RotateGroupAccessToken(gid any, id int64, opt *RotateGroupAccessTokenOptions, options ...RequestOptionFunc) (*GroupAccessToken, *Response, error)

RotateGroupAccessToken revokes a group access token and returns a new group access token that expires in one week per default.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#rotate-a-group-access-token

func (*GroupAccessTokensService) RotateGroupAccessTokenSelf added in v0.127.0 

func (s *GroupAccessTokensService) RotateGroupAccessTokenSelf(gid any, opt *RotateGroupAccessTokenOptions, options ...RequestOptionFunc) (*GroupAccessToken, *Response, error)

RotateGroupAccessTokenSelf revokes the group access token used for the request and returns a new group access token that expires in one week per default.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#self-rotate

type GroupAccessTokensServiceInterface added in v0.126.0 

type GroupAccessTokensServiceInterface interface {
	ListGroupAccessTokens(gid any, opt *ListGroupAccessTokensOptions, options ...RequestOptionFunc) ([]*GroupAccessToken, *Response, error)
	GetGroupAccessToken(gid any, id int64, options ...RequestOptionFunc) (*GroupAccessToken, *Response, error)
	CreateGroupAccessToken(gid any, opt *CreateGroupAccessTokenOptions, options ...RequestOptionFunc) (*GroupAccessToken, *Response, error)
	RotateGroupAccessToken(gid any, id int64, opt *RotateGroupAccessTokenOptions, options ...RequestOptionFunc) (*GroupAccessToken, *Response, error)
	RotateGroupAccessTokenSelf(gid any, opt *RotateGroupAccessTokenOptions, options ...RequestOptionFunc) (*GroupAccessToken, *Response, error)
	RevokeGroupAccessToken(gid any, id int64, options ...RequestOptionFunc) (*Response, error)
}

GroupAccessTokensServiceInterface defines all the API methods for the GroupAccessTokensService

type GroupActivityAnalyticsService added in v0.128.0 

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

GroupActivityAnalyticsService handles communication with the group activity analytics related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_activity_analytics/

func (*GroupActivityAnalyticsService) GetRecentlyAddedMembersCount added in v0.128.0 

func (s *GroupActivityAnalyticsService) GetRecentlyAddedMembersCount(opt *GetRecentlyAddedMembersCountOptions, options ...RequestOptionFunc) (*NewMembersCount, *Response, error)

func (*GroupActivityAnalyticsService) GetRecentlyCreatedIssuesCount added in v0.128.0 

func (s *GroupActivityAnalyticsService) GetRecentlyCreatedIssuesCount(opt *GetRecentlyCreatedIssuesCountOptions, options ...RequestOptionFunc) (*IssuesCount, *Response, error)

func (*GroupActivityAnalyticsService) GetRecentlyCreatedMergeRequestsCount added in v0.128.0 

func (s *GroupActivityAnalyticsService) GetRecentlyCreatedMergeRequestsCount(opt *GetRecentlyCreatedMergeRequestsCountOptions, options ...RequestOptionFunc) (*MergeRequestsCount, *Response, error)

type GroupActivityAnalyticsServiceInterface added in v0.128.0 

type GroupActivityAnalyticsServiceInterface interface {
	// GetRecentlyCreatedIssuesCount gets the count of recently created issues for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_activity_analytics/#get-count-of-recently-created-issues-for-group
	GetRecentlyCreatedIssuesCount(opt *GetRecentlyCreatedIssuesCountOptions, options ...RequestOptionFunc) (*IssuesCount, *Response, error)
	// GetRecentlyCreatedMergeRequestsCount gets the count of recently created merge
	// requests for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_activity_analytics/#get-count-of-recently-created-merge-requests-for-group
	GetRecentlyCreatedMergeRequestsCount(opt *GetRecentlyCreatedMergeRequestsCountOptions, options ...RequestOptionFunc) (*MergeRequestsCount, *Response, error)
	// GetRecentlyAddedMembersCount gets the count of recently added members to a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_activity_analytics/#get-count-of-members-recently-added-to-group
	GetRecentlyAddedMembersCount(opt *GetRecentlyAddedMembersCountOptions, options ...RequestOptionFunc) (*NewMembersCount, *Response, error)
}

type GroupAvatar added in v0.116.0 

type GroupAvatar struct {
	Filename string
	Image    io.Reader
}

GroupAvatar represents a GitLab group avatar.

GitLab API docs: https://docs.gitlab.com/api/groups/

func (*GroupAvatar) MarshalJSON added in v0.116.0 

func (a *GroupAvatar) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

type GroupBadge added in v0.116.0 

type GroupBadge struct {
	ID               int64     `json:"id"`
	Name             string    `json:"name"`
	LinkURL          string    `json:"link_url"`
	ImageURL         string    `json:"image_url"`
	RenderedLinkURL  string    `json:"rendered_link_url"`
	RenderedImageURL string    `json:"rendered_image_url"`
	Kind             BadgeKind `json:"kind"`
}

GroupBadge represents a group badge.

GitLab API docs: https://docs.gitlab.com/api/group_badges/

type GroupBadgePreviewOptions added in v0.116.0 

type GroupBadgePreviewOptions struct {
	LinkURL  *string `url:"link_url,omitempty" json:"link_url,omitempty"`
	ImageURL *string `url:"image_url,omitempty" json:"image_url,omitempty"`
	Name     *string `url:"name,omitempty" json:"name,omitempty"`
}

GroupBadgePreviewOptions represents the available PreviewGroupBadge() options.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#preview-a-badge-from-a-group

type GroupBadgesService added in v0.116.0 

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

GroupBadgesService handles communication with the group badges

GitLab API docs: https://docs.gitlab.com/api/group_badges/

func (*GroupBadgesService) AddGroupBadge added in v0.116.0 

func (s *GroupBadgesService) AddGroupBadge(gid any, opt *AddGroupBadgeOptions, options ...RequestOptionFunc) (*GroupBadge, *Response, error)

AddGroupBadge adds a badge to a group.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#add-a-badge-to-a-group

func (*GroupBadgesService) DeleteGroupBadge added in v0.116.0 

func (s *GroupBadgesService) DeleteGroupBadge(gid any, badge int64, options ...RequestOptionFunc) (*Response, error)

DeleteGroupBadge removes a badge from a group.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#remove-a-badge-from-a-group

func (*GroupBadgesService) EditGroupBadge added in v0.116.0 

func (s *GroupBadgesService) EditGroupBadge(gid any, badge int64, opt *EditGroupBadgeOptions, options ...RequestOptionFunc) (*GroupBadge, *Response, error)

EditGroupBadge updates a badge of a group.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#edit-a-badge-of-a-group

func (*GroupBadgesService) GetGroupBadge added in v0.116.0 

func (s *GroupBadgesService) GetGroupBadge(gid any, badge int64, options ...RequestOptionFunc) (*GroupBadge, *Response, error)

GetGroupBadge gets a group badge.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#get-a-badge-of-a-group

func (*GroupBadgesService) ListGroupBadges added in v0.116.0 

func (s *GroupBadgesService) ListGroupBadges(gid any, opt *ListGroupBadgesOptions, options ...RequestOptionFunc) ([]*GroupBadge, *Response, error)

ListGroupBadges gets a list of a group badges.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#list-all-badges-of-a-group

func (*GroupBadgesService) PreviewGroupBadge added in v0.116.0 

func (s *GroupBadgesService) PreviewGroupBadge(gid any, opt *GroupBadgePreviewOptions, options ...RequestOptionFunc) (*GroupBadge, *Response, error)

PreviewGroupBadge returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#preview-a-badge-from-a-group

type GroupBadgesServiceInterface added in v0.126.0 

type GroupBadgesServiceInterface interface {
	ListGroupBadges(gid any, opt *ListGroupBadgesOptions, options ...RequestOptionFunc) ([]*GroupBadge, *Response, error)
	GetGroupBadge(gid any, badge int64, options ...RequestOptionFunc) (*GroupBadge, *Response, error)
	AddGroupBadge(gid any, opt *AddGroupBadgeOptions, options ...RequestOptionFunc) (*GroupBadge, *Response, error)
	EditGroupBadge(gid any, badge int64, opt *EditGroupBadgeOptions, options ...RequestOptionFunc) (*GroupBadge, *Response, error)
	DeleteGroupBadge(gid any, badge int64, options ...RequestOptionFunc) (*Response, error)
	PreviewGroupBadge(gid any, opt *GroupBadgePreviewOptions, options ...RequestOptionFunc) (*GroupBadge, *Response, error)
}

GroupBadgesServiceInterface defines all the API methods for the GroupBadgesService

type GroupBranchAccessDescription added in v1.23.0 

type GroupBranchAccessDescription struct {
	ID                     int64            `json:"id"`
	AccessLevel            AccessLevelValue `json:"access_level"`
	AccessLevelDescription string           `json:"access_level_description"`
	DeployKeyID            int64            `json:"deploy_key_id"`
	UserID                 int64            `json:"user_id"`
	GroupID                int64            `json:"group_id"`
}

GroupBranchAccessDescription represents the access description for a group protected branch.

GitLab API docs: https://docs.gitlab.com/api/group_protected_branches/#list-protected-branches

type GroupBranchPermissionOptions added in v1.23.0 

type GroupBranchPermissionOptions struct {
	ID          *int64            `url:"id,omitempty" json:"id,omitempty"`
	UserID      *int64            `url:"user_id,omitempty" json:"user_id,omitempty"`
	GroupID     *int64            `url:"group_id,omitempty" json:"group_id,omitempty"`
	DeployKeyID *int64            `url:"deploy_key_id,omitempty" json:"deploy_key_id,omitempty"`
	AccessLevel *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	Destroy     *bool             `url:"_destroy,omitempty" json:"_destroy,omitempty"`
}

GroupBranchPermissionOptions represents a branch permission option.

GitLab API docs: https://docs.gitlab.com/api/group_protected_branches/#protect-repository-branches

type GroupCluster added in v0.116.0 

type GroupCluster struct {
	ID                 int64               `json:"id"`
	Name               string              `json:"name"`
	Domain             string              `json:"domain"`
	CreatedAt          *time.Time          `json:"created_at"`
	Managed            bool                `json:"managed"`
	Enabled            bool                `json:"enabled"`
	ProviderType       string              `json:"provider_type"`
	PlatformType       string              `json:"platform_type"`
	EnvironmentScope   string              `json:"environment_scope"`
	ClusterType        string              `json:"cluster_type"`
	User               *User               `json:"user"`
	PlatformKubernetes *PlatformKubernetes `json:"platform_kubernetes"`
	ManagementProject  *ManagementProject  `json:"management_project"`
	Group              *Group              `json:"group"`
}

GroupCluster represents a GitLab Group Cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/group_clusters/

func (GroupCluster) String deprecated added in v0.116.0 

func (v GroupCluster) String() string

Deprecated: in GitLab 14.5, to be removed in 19.0

type GroupClustersService added in v0.116.0 

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

GroupClustersService handles communication with the group clusters related methods of the GitLab API. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/group_clusters/

func (*GroupClustersService) AddCluster added in v0.116.0 

func (s *GroupClustersService) AddCluster(pid any, opt *AddGroupClusterOptions, options ...RequestOptionFunc) (*GroupCluster, *Response, error)

AddCluster adds an existing cluster to the group. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/group_clusters/#add-existing-cluster-to-group

func (*GroupClustersService) DeleteCluster added in v0.116.0 

func (s *GroupClustersService) DeleteCluster(pid any, cluster int64, options ...RequestOptionFunc) (*Response, error)

DeleteCluster deletes an existing group cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/group_clusters/#delete-group-cluster

func (*GroupClustersService) EditCluster added in v0.116.0 

func (s *GroupClustersService) EditCluster(pid any, cluster int64, opt *EditGroupClusterOptions, options ...RequestOptionFunc) (*GroupCluster, *Response, error)

EditCluster updates an existing group cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/group_clusters/#edit-group-cluster

func (*GroupClustersService) GetCluster added in v0.116.0 

func (s *GroupClustersService) GetCluster(pid any, cluster int64, options ...RequestOptionFunc) (*GroupCluster, *Response, error)

GetCluster gets a cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/group_clusters/#get-a-single-group-cluster

func (*GroupClustersService) ListClusters added in v0.116.0 

func (s *GroupClustersService) ListClusters(pid any, options ...RequestOptionFunc) ([]*GroupCluster, *Response, error)

ListClusters gets a list of all clusters in a group. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/group_clusters/#list-group-clusters

type GroupClustersServiceInterface deprecated added in v0.126.0 

type GroupClustersServiceInterface interface {
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	ListClusters(pid any, options ...RequestOptionFunc) ([]*GroupCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	GetCluster(pid any, cluster int64, options ...RequestOptionFunc) (*GroupCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	AddCluster(pid any, opt *AddGroupClusterOptions, options ...RequestOptionFunc) (*GroupCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	EditCluster(pid any, cluster int64, opt *EditGroupClusterOptions, options ...RequestOptionFunc) (*GroupCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	DeleteCluster(pid any, cluster int64, options ...RequestOptionFunc) (*Response, error)
}

Deprecated: in GitLab 14.5, to be removed in 19.0

type GroupCredentialsService added in v1.2.0 

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

GroupCredentialsService handles communication with the top-level group credentials inventory management endpoints of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/groups/#credentials-inventory-management

func (*GroupCredentialsService) DeleteGroupSSHKey added in v1.3.0 

func (g *GroupCredentialsService) DeleteGroupSSHKey(gid any, keyID int64, options ...RequestOptionFunc) (*Response, error)

func (*GroupCredentialsService) ListGroupPersonalAccessTokens added in v1.2.0 

func (g *GroupCredentialsService) ListGroupPersonalAccessTokens(gid any, opt *ListGroupPersonalAccessTokensOptions, options ...RequestOptionFunc) ([]*GroupPersonalAccessToken, *Response, error)

func (*GroupCredentialsService) ListGroupSSHKeys added in v1.3.0 

func (g *GroupCredentialsService) ListGroupSSHKeys(gid any, opt *ListGroupSSHKeysOptions, options ...RequestOptionFunc) ([]*GroupSSHKey, *Response, error)

func (*GroupCredentialsService) RevokeGroupPersonalAccessToken added in v1.3.0 

func (g *GroupCredentialsService) RevokeGroupPersonalAccessToken(gid any, tokenID int64, options ...RequestOptionFunc) (*Response, error)

type GroupCredentialsServiceInterface added in v1.2.0 

type GroupCredentialsServiceInterface interface {
	// ListGroupPersonalAccessTokens lists all personal access tokens
	// associated with enterprise users in a top-level group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/groups/#list-all-personal-access-tokens-for-a-group
	ListGroupPersonalAccessTokens(gid any, opt *ListGroupPersonalAccessTokensOptions, options ...RequestOptionFunc) ([]*GroupPersonalAccessToken, *Response, error)
	// ListGroupSSHKeys lists all SSH public keys associated with
	// enterprise users in a top-level group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/groups/#list-all-ssh-keys-for-a-group
	ListGroupSSHKeys(gid any, opt *ListGroupSSHKeysOptions, options ...RequestOptionFunc) ([]*GroupSSHKey, *Response, error)
	// RevokeGroupPersonalAccessToken revokes a specified personal access token
	// for an enterprise user.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/groups/#revoke-a-personal-access-token-for-an-enterprise-user
	RevokeGroupPersonalAccessToken(gid any, tokenID int64, options ...RequestOptionFunc) (*Response, error)
	// DeleteGroupSSHKey deletes a specified SSH public key for an
	// enterprise user associated with the top-level group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/groups/#delete-an-ssh-key-for-an-enterprise-user
	DeleteGroupSSHKey(gid any, keyID int64, options ...RequestOptionFunc) (*Response, error)
}

type GroupEnvironmentAccessDescription added in v0.116.0 

type GroupEnvironmentAccessDescription struct {
	ID                     int64            `json:"id"`
	AccessLevel            AccessLevelValue `json:"access_level"`
	AccessLevelDescription string           `json:"access_level_description"`
	UserID                 int64            `json:"user_id"`
	GroupID                int64            `json:"group_id"`
	GroupInheritanceType   int64            `json:"group_inheritance_type"`
}

GroupEnvironmentAccessDescription represents the access description for a group-level protected environment.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/

type GroupEnvironmentAccessOptions added in v0.116.0 

type GroupEnvironmentAccessOptions struct {
	AccessLevel          *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	UserID               *int64            `url:"user_id,omitempty" json:"user_id,omitempty"`
	GroupID              *int64            `url:"group_id,omitempty" json:"group_id,omitempty"`
	GroupInheritanceType *int64            `url:"group_inheritance_type,omitempty" json:"group_inheritance_type,omitempty"`
}

GroupEnvironmentAccessOptions represents the options for an access description for a group-level protected environment.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/#protect-a-single-environment

type GroupEnvironmentApprovalRule added in v0.116.0 

type GroupEnvironmentApprovalRule struct {
	ID                     int64            `json:"id"`
	UserID                 int64            `json:"user_id"`
	GroupID                int64            `json:"group_id"`
	AccessLevel            AccessLevelValue `json:"access_level"`
	AccessLevelDescription string           `json:"access_level_description"`
	RequiredApprovalCount  int64            `json:"required_approvals"`
	GroupInheritanceType   int64            `json:"group_inheritance_type"`
}

GroupEnvironmentApprovalRule represents the approval rules for a group-level protected environment.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/#protect-a-single-environment

type GroupEnvironmentApprovalRuleOptions added in v0.116.0 

type GroupEnvironmentApprovalRuleOptions struct {
	UserID                 *int64            `url:"user_id,omitempty" json:"user_id,omitempty"`
	GroupID                *int64            `url:"group_id,omitempty" json:"group_id,omitempty"`
	AccessLevel            *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	AccessLevelDescription *string           `url:"access_level_description,omitempty" json:"access_level_description,omitempty"`
	RequiredApprovalCount  *int64            `url:"required_approvals,omitempty" json:"required_approvals,omitempty"`
	GroupInheritanceType   *int64            `url:"group_inheritance_type,omitempty" json:"group_inheritance_type,omitempty"`
}

GroupEnvironmentApprovalRuleOptions represents the approval rules for a group-level protected environment.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/#protect-a-single-environment

type GroupEpicBoard added in v0.116.0 

type GroupEpicBoard struct {
	ID     int64           `json:"id"`
	Name   string          `json:"name"`
	Group  *Group          `json:"group"`
	Labels []*LabelDetails `json:"labels"`
	Lists  []*BoardList    `json:"lists"`
}

GroupEpicBoard represents a GitLab group epic board.

GitLab API docs: https://docs.gitlab.com/api/group_epic_boards/

func (GroupEpicBoard) String added in v0.116.0 

func (b GroupEpicBoard) String() string

type GroupEpicBoardsService added in v0.116.0 

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

GroupEpicBoardsService handles communication with the group epic board related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_epic_boards/

func (*GroupEpicBoardsService) GetGroupEpicBoard added in v0.116.0 

func (s *GroupEpicBoardsService) GetGroupEpicBoard(gid any, board int64, options ...RequestOptionFunc) (*GroupEpicBoard, *Response, error)

GetGroupEpicBoard gets a single epic board of a group.

GitLab API docs: https://docs.gitlab.com/api/group_epic_boards/#single-group-epic-board

func (*GroupEpicBoardsService) ListGroupEpicBoards added in v0.116.0 

func (s *GroupEpicBoardsService) ListGroupEpicBoards(gid any, opt *ListGroupEpicBoardsOptions, options ...RequestOptionFunc) ([]*GroupEpicBoard, *Response, error)

ListGroupEpicBoards gets a list of all epic boards in a group.

GitLab API docs: https://docs.gitlab.com/api/group_epic_boards/#list-all-epic-boards-in-a-group

type GroupEpicBoardsServiceInterface added in v0.126.0 

type GroupEpicBoardsServiceInterface interface {
	ListGroupEpicBoards(gid any, opt *ListGroupEpicBoardsOptions, options ...RequestOptionFunc) ([]*GroupEpicBoard, *Response, error)
	GetGroupEpicBoard(gid any, board int64, options ...RequestOptionFunc) (*GroupEpicBoard, *Response, error)
}

type GroupHook added in v0.116.0 

type GroupHook struct {
	ID                        int64               `json:"id"`
	URL                       string              `json:"url"`
	Name                      string              `json:"name"`
	Description               string              `json:"description"`
	CreatedAt                 *time.Time          `json:"created_at"`
	PushEvents                bool                `json:"push_events"`
	TagPushEvents             bool                `json:"tag_push_events"`
	MergeRequestsEvents       bool                `json:"merge_requests_events"`
	RepositoryUpdateEvents    bool                `json:"repository_update_events"`
	EnableSSLVerification     bool                `json:"enable_ssl_verification"`
	AlertStatus               string              `json:"alert_status"`
	PushEventsBranchFilter    string              `json:"push_events_branch_filter"`
	BranchFilterStrategy      string              `json:"branch_filter_strategy"`
	CustomWebhookTemplate     string              `json:"custom_webhook_template"`
	CustomHeaders             []*HookCustomHeader `url:"custom_headers,omitempty" json:"custom_headers,omitempty"`
	GroupID                   int64               `json:"group_id"`
	IssuesEvents              bool                `json:"issues_events"`
	ConfidentialIssuesEvents  bool                `json:"confidential_issues_events"`
	NoteEvents                bool                `json:"note_events"`
	ConfidentialNoteEvents    bool                `json:"confidential_note_events"`
	PipelineEvents            bool                `json:"pipeline_events"`
	WikiPageEvents            bool                `json:"wiki_page_events"`
	JobEvents                 bool                `json:"job_events"`
	DeploymentEvents          bool                `json:"deployment_events"`
	FeatureFlagEvents         bool                `json:"feature_flag_events"`
	ReleasesEvents            bool                `json:"releases_events"`
	SubGroupEvents            bool                `json:"subgroup_events"`
	EmojiEvents               bool                `json:"emoji_events"`
	ResourceAccessTokenEvents bool                `json:"resource_access_token_events"`
	MemberEvents              bool                `json:"member_events"`
	ProjectEvents             bool                `json:"project_events"`
	MilestoneEvents           bool                `json:"milestone_events"`
	VulnerabilityEvents       bool                `json:"vulnerability_events"`
}

GroupHook represents a GitLab group hook.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/

type GroupHookTrigger added in v0.116.0 

type GroupHookTrigger string

GroupHookTrigger represents the type of event to trigger for a group hook test. 

const (
	GroupHookTriggerPush                GroupHookTrigger = "push_events"
	GroupHookTriggerTagPush             GroupHookTrigger = "tag_push_events"
	GroupHookTriggerIssue               GroupHookTrigger = "issues_events"
	GroupHookTriggerConfidentialIssue   GroupHookTrigger = "confidential_issues_events"
	GroupHookTriggerNote                GroupHookTrigger = "note_events"
	GroupHookTriggerMergeRequest        GroupHookTrigger = "merge_requests_events"
	GroupHookTriggerJob                 GroupHookTrigger = "job_events"
	GroupHookTriggerPipeline            GroupHookTrigger = "pipeline_events"
	GroupHookTriggerWikiPage            GroupHookTrigger = "wiki_page_events"
	GroupHookTriggerRelease             GroupHookTrigger = "releases_events"
	GroupHookTriggerEmoji               GroupHookTrigger = "emoji_events"
	GroupHookTriggerResourceAccessToken GroupHookTrigger = "resource_access_token_events"
)

List of available group hook trigger types.

type GroupID added in v0.160.1 

type GroupID struct {
	Value any
}

type GroupImportExportService added in v0.116.0 

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

GroupImportExportService handles communication with the group import export related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_import_export/

func (*GroupImportExportService) ExportDownload added in v0.116.0 

func (s *GroupImportExportService) ExportDownload(gid any, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)

ExportDownload downloads the finished export.

GitLab API docs: https://docs.gitlab.com/api/group_import_export/#export-download

func (*GroupImportExportService) ImportFile added in v0.116.0 

func (s *GroupImportExportService) ImportFile(opt *GroupImportFileOptions, options ...RequestOptionFunc) (*Response, error)

ImportFile imports a file.

GitLab API docs: https://docs.gitlab.com/api/group_import_export/#import-a-file

func (*GroupImportExportService) ScheduleExport added in v0.116.0 

func (s *GroupImportExportService) ScheduleExport(gid any, options ...RequestOptionFunc) (*Response, error)

ScheduleExport starts a new group export.

GitLab API docs: https://docs.gitlab.com/api/group_import_export/#schedule-new-export

type GroupImportExportServiceInterface added in v0.126.0 

type GroupImportExportServiceInterface interface {
	ScheduleExport(gid any, options ...RequestOptionFunc) (*Response, error)
	ExportDownload(gid any, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)
	ImportFile(opt *GroupImportFileOptions, options ...RequestOptionFunc) (*Response, error)
}

type GroupImportFileOptions added in v0.116.0 

type GroupImportFileOptions struct {
	Name     *string `url:"name,omitempty" json:"name,omitempty"`
	Path     *string `url:"path,omitempty" json:"path,omitempty"`
	File     *string `url:"file,omitempty" json:"file,omitempty"`
	ParentID *int64  `url:"parent_id,omitempty" json:"parent_id,omitempty"`
}

GroupImportFileOptions represents the available ImportFile() options.

GitLab API docs: https://docs.gitlab.com/api/group_import_export/#import-a-file

type GroupIssueBoard added in v0.11.0 

type GroupIssueBoard struct {
	ID        int64         `json:"id"`
	Name      string        `json:"name"`
	Group     *Group        `json:"group"`
	Milestone *Milestone    `json:"milestone"`
	Labels    []*GroupLabel `json:"labels"`
	Lists     []*BoardList  `json:"lists"`
}

GroupIssueBoard represents a GitLab group issue board.

GitLab API docs: https://docs.gitlab.com/api/group_boards/

func (GroupIssueBoard) String added in v0.11.0 

func (b GroupIssueBoard) String() string

type GroupIssueBoardsService added in v0.11.0 

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

GroupIssueBoardsService handles communication with the group issue board related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_boards/

func (*GroupIssueBoardsService) CreateGroupIssueBoard added in v0.116.0 

func (s *GroupIssueBoardsService) CreateGroupIssueBoard(gid any, opt *CreateGroupIssueBoardOptions, options ...RequestOptionFunc) (*GroupIssueBoard, *Response, error)

func (*GroupIssueBoardsService) CreateGroupIssueBoardList added in v0.11.0 

func (s *GroupIssueBoardsService) CreateGroupIssueBoardList(gid any, board int64, opt *CreateGroupIssueBoardListOptions, options ...RequestOptionFunc) (*BoardList, *Response, error)

func (*GroupIssueBoardsService) DeleteGroupIssueBoardList added in v0.11.0 

func (s *GroupIssueBoardsService) DeleteGroupIssueBoardList(gid any, board, list int64, options ...RequestOptionFunc) (*Response, error)

func (*GroupIssueBoardsService) DeleteIssueBoard added in v0.116.0 

func (s *GroupIssueBoardsService) DeleteIssueBoard(gid any, board int64, options ...RequestOptionFunc) (*Response, error)

func (*GroupIssueBoardsService) GetGroupIssueBoard added in v0.11.0 

func (s *GroupIssueBoardsService) GetGroupIssueBoard(gid any, board int64, options ...RequestOptionFunc) (*GroupIssueBoard, *Response, error)

func (*GroupIssueBoardsService) GetGroupIssueBoardList added in v0.11.0 

func (s *GroupIssueBoardsService) GetGroupIssueBoardList(gid any, board, list int64, options ...RequestOptionFunc) (*BoardList, *Response, error)

func (*GroupIssueBoardsService) ListGroupIssueBoardLists added in v0.11.0 

func (s *GroupIssueBoardsService) ListGroupIssueBoardLists(gid any, board int64, opt *ListGroupIssueBoardListsOptions, options ...RequestOptionFunc) ([]*BoardList, *Response, error)

func (*GroupIssueBoardsService) ListGroupIssueBoards added in v0.11.0 

func (s *GroupIssueBoardsService) ListGroupIssueBoards(gid any, opt *ListGroupIssueBoardsOptions, options ...RequestOptionFunc) ([]*GroupIssueBoard, *Response, error)

func (*GroupIssueBoardsService) UpdateIssueBoard added in v0.116.0 

func (s *GroupIssueBoardsService) UpdateIssueBoard(gid any, board int64, opt *UpdateGroupIssueBoardOptions, options ...RequestOptionFunc) (*GroupIssueBoard, *Response, error)

func (*GroupIssueBoardsService) UpdateIssueBoardList added in v0.11.0 

func (s *GroupIssueBoardsService) UpdateIssueBoardList(gid any, board, list int64, opt *UpdateGroupIssueBoardListOptions, options ...RequestOptionFunc) ([]*BoardList, *Response, error)

type GroupIssueBoardsServiceInterface added in v0.126.0 

type GroupIssueBoardsServiceInterface interface {
	// ListGroupIssueBoards gets a list of all issue boards in a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_boards/#list-all-group-issue-boards-in-a-group
	ListGroupIssueBoards(gid any, opt *ListGroupIssueBoardsOptions, options ...RequestOptionFunc) ([]*GroupIssueBoard, *Response, error)
	// CreateGroupIssueBoard creates a new issue board.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_boards/#create-a-group-issue-board
	CreateGroupIssueBoard(gid any, opt *CreateGroupIssueBoardOptions, options ...RequestOptionFunc) (*GroupIssueBoard, *Response, error)
	// GetGroupIssueBoard gets a single issue board of a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_boards/#single-group-issue-board
	GetGroupIssueBoard(gid any, board int64, options ...RequestOptionFunc) (*GroupIssueBoard, *Response, error)
	// UpdateIssueBoard updates a single issue board of a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_boards/#update-a-group-issue-board
	UpdateIssueBoard(gid any, board int64, opt *UpdateGroupIssueBoardOptions, options ...RequestOptionFunc) (*GroupIssueBoard, *Response, error)
	// DeleteIssueBoard deletes a single issue board of a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_boards/#delete-a-group-issue-board
	DeleteIssueBoard(gid any, board int64, options ...RequestOptionFunc) (*Response, error)
	// ListGroupIssueBoardLists gets a list of the issue board's lists. Does not include
	// backlog and closed lists.
	//
	// GitLab API docs: https://docs.gitlab.com/api/group_boards/#list-group-issue-board-lists
	ListGroupIssueBoardLists(gid any, board int64, opt *ListGroupIssueBoardListsOptions, options ...RequestOptionFunc) ([]*BoardList, *Response, error)
	// GetGroupIssueBoardList gets a single issue board list.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_boards/#single-group-issue-board-list
	GetGroupIssueBoardList(gid any, board, list int64, options ...RequestOptionFunc) (*BoardList, *Response, error)
	// CreateGroupIssueBoardList creates a new issue board list.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_boards/#new-group-issue-board-list
	CreateGroupIssueBoardList(gid any, board int64, opt *CreateGroupIssueBoardListOptions, options ...RequestOptionFunc) (*BoardList, *Response, error)
	// UpdateIssueBoardList updates the position of an existing
	// group issue board list.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_boards/#edit-group-issue-board-list
	UpdateIssueBoardList(gid any, board, list int64, opt *UpdateGroupIssueBoardListOptions, options ...RequestOptionFunc) ([]*BoardList, *Response, error)
	DeleteGroupIssueBoardList(gid any, board, list int64, options ...RequestOptionFunc) (*Response, error)
}

type GroupIteration added in v0.116.0 

type GroupIteration struct {
	ID          int64      `json:"id"`
	IID         int64      `json:"iid"`
	Sequence    int64      `json:"sequence"`
	GroupID     int64      `json:"group_id"`
	Title       string     `json:"title"`
	Description string     `json:"description"`
	State       int64      `json:"state"`
	CreatedAt   *time.Time `json:"created_at"`
	UpdatedAt   *time.Time `json:"updated_at"`
	DueDate     *ISOTime   `json:"due_date"`
	StartDate   *ISOTime   `json:"start_date"`
	WebURL      string     `json:"web_url"`
}

GroupIteration represents a GitLab iteration.

GitLab API docs: https://docs.gitlab.com/api/group_iterations/

func (GroupIteration) String added in v0.116.0 

func (i GroupIteration) String() string

type GroupIterationsService added in v0.116.0 

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

GroupIterationsService handles communication with the iterations related methods of the GitLab API

GitLab API docs: https://docs.gitlab.com/api/group_iterations/

func (*GroupIterationsService) ListGroupIterations added in v0.116.0 

func (s *GroupIterationsService) ListGroupIterations(gid any, opt *ListGroupIterationsOptions, options ...RequestOptionFunc) ([]*GroupIteration, *Response, error)

ListGroupIterations returns a list of group iterations.

GitLab API docs: https://docs.gitlab.com/api/group_iterations/#list-group-iterations

type GroupIterationsServiceInterface added in v0.126.0 

type GroupIterationsServiceInterface interface {
	ListGroupIterations(gid any, opt *ListGroupIterationsOptions, options ...RequestOptionFunc) ([]*GroupIteration, *Response, error)
}

type GroupLabel added in v0.116.0 

type GroupLabel Label

GroupLabel represents a GitLab group label.

GitLab API docs: https://docs.gitlab.com/api/group_labels/

func (GroupLabel) String added in v0.116.0 

func (l GroupLabel) String() string

type GroupLabelsService added in v0.116.0 

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

GroupLabelsService handles communication with the label related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_labels/

func (*GroupLabelsService) CreateGroupLabel added in v0.116.0 

func (s *GroupLabelsService) CreateGroupLabel(gid any, opt *CreateGroupLabelOptions, options ...RequestOptionFunc) (*GroupLabel, *Response, error)

CreateGroupLabel creates a new label for given group with given name and color.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#create-a-new-group-label

func (*GroupLabelsService) DeleteGroupLabel added in v0.116.0 

func (s *GroupLabelsService) DeleteGroupLabel(gid any, lid any, opt *DeleteGroupLabelOptions, options ...RequestOptionFunc) (*Response, error)

DeleteGroupLabel deletes a group label given by its name or ID.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#delete-a-group-label

func (*GroupLabelsService) GetGroupLabel added in v0.116.0 

func (s *GroupLabelsService) GetGroupLabel(gid any, lid any, options ...RequestOptionFunc) (*GroupLabel, *Response, error)

GetGroupLabel get a single label for a given group.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#get-a-single-group-label

func (*GroupLabelsService) ListGroupLabels added in v0.116.0 

func (s *GroupLabelsService) ListGroupLabels(gid any, opt *ListGroupLabelsOptions, options ...RequestOptionFunc) ([]*GroupLabel, *Response, error)

ListGroupLabels gets all labels for given group.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#list-group-labels

func (*GroupLabelsService) SubscribeToGroupLabel added in v0.116.0 

func (s *GroupLabelsService) SubscribeToGroupLabel(gid any, lid any, options ...RequestOptionFunc) (*GroupLabel, *Response, error)

SubscribeToGroupLabel subscribes the authenticated user to a label to receive notifications. If the user is already subscribed to the label, the status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#subscribe-to-a-group-label

func (*GroupLabelsService) UnsubscribeFromGroupLabel added in v0.116.0 

func (s *GroupLabelsService) UnsubscribeFromGroupLabel(gid any, lid any, options ...RequestOptionFunc) (*Response, error)

UnsubscribeFromGroupLabel unsubscribes the authenticated user from a label to not receive notifications from it. If the user is not subscribed to the label, the status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#unsubscribe-from-a-group-label

func (*GroupLabelsService) UpdateGroupLabel added in v0.116.0 

func (s *GroupLabelsService) UpdateGroupLabel(gid any, lid any, opt *UpdateGroupLabelOptions, options ...RequestOptionFunc) (*GroupLabel, *Response, error)

UpdateGroupLabel updates an existing label with new name or now color. At least one parameter is required, to update the label.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#update-a-group-label

type GroupLabelsServiceInterface added in v0.126.0 

type GroupLabelsServiceInterface interface {
	ListGroupLabels(gid any, opt *ListGroupLabelsOptions, options ...RequestOptionFunc) ([]*GroupLabel, *Response, error)
	GetGroupLabel(gid any, lid any, options ...RequestOptionFunc) (*GroupLabel, *Response, error)
	CreateGroupLabel(gid any, opt *CreateGroupLabelOptions, options ...RequestOptionFunc) (*GroupLabel, *Response, error)
	DeleteGroupLabel(gid any, lid any, opt *DeleteGroupLabelOptions, options ...RequestOptionFunc) (*Response, error)
	UpdateGroupLabel(gid any, lid any, opt *UpdateGroupLabelOptions, options ...RequestOptionFunc) (*GroupLabel, *Response, error)
	SubscribeToGroupLabel(gid any, lid any, options ...RequestOptionFunc) (*GroupLabel, *Response, error)
	UnsubscribeFromGroupLabel(gid any, lid any, options ...RequestOptionFunc) (*Response, error)
}

type GroupMarkdownUpload added in v0.129.0 

type GroupMarkdownUpload = MarkdownUpload

Type aliases for backward compatibility

type GroupMarkdownUploadsService added in v0.129.0 

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

GroupMarkdownUploadsService handles communication with the group markdown uploads related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/

func (*GroupMarkdownUploadsService) DeleteGroupMarkdownUploadByID added in v0.129.0 

func (s *GroupMarkdownUploadsService) DeleteGroupMarkdownUploadByID(gid any, uploadID int64, options ...RequestOptionFunc) (*Response, error)

func (*GroupMarkdownUploadsService) DeleteGroupMarkdownUploadBySecretAndFilename added in v0.129.0 

func (s *GroupMarkdownUploadsService) DeleteGroupMarkdownUploadBySecretAndFilename(gid any, secret string, filename string, options ...RequestOptionFunc) (*Response, error)

func (*GroupMarkdownUploadsService) DownloadGroupMarkdownUploadByID added in v0.129.0 

func (s *GroupMarkdownUploadsService) DownloadGroupMarkdownUploadByID(gid any, uploadID int64, options ...RequestOptionFunc) (io.Reader, *Response, error)

func (*GroupMarkdownUploadsService) DownloadGroupMarkdownUploadBySecretAndFilename added in v0.129.0 

func (s *GroupMarkdownUploadsService) DownloadGroupMarkdownUploadBySecretAndFilename(gid any, secret string, filename string, options ...RequestOptionFunc) (io.Reader, *Response, error)

func (*GroupMarkdownUploadsService) ListGroupMarkdownUploads added in v0.129.0 

func (s *GroupMarkdownUploadsService) ListGroupMarkdownUploads(gid any, opt *ListMarkdownUploadsOptions, options ...RequestOptionFunc) ([]*GroupMarkdownUpload, *Response, error)

type GroupMarkdownUploadsServiceInterface added in v0.129.0 

type GroupMarkdownUploadsServiceInterface interface {
	// ListGroupMarkdownUploads gets all markdown uploads for a group.
	//
	// GitLab API Docs:
	// https://docs.gitlab.com/api/group_markdown_uploads/#list-uploads
	ListGroupMarkdownUploads(gid any, opt *ListMarkdownUploadsOptions, options ...RequestOptionFunc) ([]*GroupMarkdownUpload, *Response, error)
	// DownloadGroupMarkdownUploadByID downloads a specific upload by ID.
	//
	// GitLab API Docs:
	// https://docs.gitlab.com/api/group_markdown_uploads/#download-an-uploaded-file-by-id
	DownloadGroupMarkdownUploadByID(gid any, uploadID int64, options ...RequestOptionFunc) (io.Reader, *Response, error)
	// DownloadGroupMarkdownUploadBySecretAndFilename downloads a specific upload
	// by secret and filename.
	//
	// GitLab API Docs:
	// https://docs.gitlab.com/api/group_markdown_uploads/#download-an-uploaded-file-by-secret-and-filename
	DownloadGroupMarkdownUploadBySecretAndFilename(gid any, secret string, filename string, options ...RequestOptionFunc) (io.Reader, *Response, error)
	// DeleteGroupMarkdownUploadByID deletes an upload by ID.
	//
	// GitLab API Docs:
	// https://docs.gitlab.com/api/group_markdown_uploads/#delete-an-uploaded-file-by-id
	DeleteGroupMarkdownUploadByID(gid any, uploadID int64, options ...RequestOptionFunc) (*Response, error)
	// DeleteGroupMarkdownUploadBySecretAndFilename deletes an upload
	// by secret and filename.
	//
	// GitLab API Docs:
	// https://docs.gitlab.com/api/group_markdown_uploads/#delete-an-uploaded-file-by-secret-and-filename
	DeleteGroupMarkdownUploadBySecretAndFilename(gid any, secret string, filename string, options ...RequestOptionFunc) (*Response, error)
}

type GroupMattermostIntegration added in v1.17.0 

type GroupMattermostIntegration struct {
	Integration
	NotifyOnlyBrokenPipelines  bool                                  `json:"notify_only_broken_pipelines"`
	BranchesToBeNotified       string                                `json:"branches_to_be_notified"`
	LabelsToBeNotified         string                                `json:"labels_to_be_notified"`
	LabelsToBeNotifiedBehavior string                                `json:"labels_to_be_notified_behavior"`
	NotifyOnlyDefaultBranch    bool                                  `json:"notify_only_default_branch"`
	Properties                 *GroupMattermostIntegrationProperties `json:"properties"`
}

GroupMattermostIntegration represents a Mattermost integration for a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-notifications

type GroupMattermostIntegrationOptions added in v1.17.0 

type GroupMattermostIntegrationOptions struct {
	WebHook                    *string `url:"webhook,omitempty" json:"webhook,omitempty"`
	Username                   *string `url:"username,omitempty" json:"username,omitempty"`
	Channel                    *string `url:"channel,omitempty" json:"channel,omitempty"`
	NotifyOnlyBrokenPipelines  *bool   `url:"notify_only_broken_pipelines,omitempty" json:"notify_only_broken_pipelines,omitempty"`
	BranchesToBeNotified       *string `url:"branches_to_be_notified,omitempty" json:"branches_to_be_notified,omitempty"`
	PushEvents                 *bool   `url:"push_events,omitempty" json:"push_events,omitempty"`
	IssuesEvents               *bool   `url:"issues_events,omitempty" json:"issues_events,omitempty"`
	ConfidentialIssuesEvents   *bool   `url:"confidential_issues_events,omitempty" json:"confidential_issues_events,omitempty"`
	MergeRequestsEvents        *bool   `url:"merge_requests_events,omitempty" json:"merge_requests_events,omitempty"`
	TagPushEvents              *bool   `url:"tag_push_events,omitempty" json:"tag_push_events,omitempty"`
	NoteEvents                 *bool   `url:"note_events,omitempty" json:"note_events,omitempty"`
	ConfidentialNoteEvents     *bool   `url:"confidential_note_events,omitempty" json:"confidential_note_events,omitempty"`
	PipelineEvents             *bool   `url:"pipeline_events,omitempty" json:"pipeline_events,omitempty"`
	WikiPageEvents             *bool   `url:"wiki_page_events,omitempty" json:"wiki_page_events,omitempty"`
	DeploymentEvents           *bool   `url:"deployment_events,omitempty" json:"deployment_events,omitempty"`
	AlertEvents                *bool   `url:"alert_events,omitempty" json:"alert_events,omitempty"`
	VulnerabilityEvents        *bool   `url:"vulnerability_events,omitempty" json:"vulnerability_events,omitempty"`
	PushChannel                *string `url:"push_channel,omitempty" json:"push_channel,omitempty"`
	IssueChannel               *string `url:"issue_channel,omitempty" json:"issue_channel,omitempty"`
	ConfidentialIssueChannel   *string `url:"confidential_issue_channel,omitempty" json:"confidential_issue_channel,omitempty"`
	MergeRequestChannel        *string `url:"merge_request_channel,omitempty" json:"merge_request_channel,omitempty"`
	NoteChannel                *string `url:"note_channel,omitempty" json:"note_channel,omitempty"`
	ConfidentialNoteChannel    *string `url:"confidential_note_channel,omitempty" json:"confidential_note_channel,omitempty"`
	TagPushChannel             *string `url:"tag_push_channel,omitempty" json:"tag_push_channel,omitempty"`
	PipelineChannel            *string `url:"pipeline_channel,omitempty" json:"pipeline_channel,omitempty"`
	WikiPageChannel            *string `url:"wiki_page_channel,omitempty" json:"wiki_page_channel,omitempty"`
	DeploymentChannel          *string `url:"deployment_channel,omitempty" json:"deployment_channel,omitempty"`
	AlertChannel               *string `url:"alert_channel,omitempty" json:"alert_channel,omitempty"`
	VulnerabilityChannel       *string `url:"vulnerability_channel,omitempty" json:"vulnerability_channel,omitempty"`
	LabelsToBeNotified         *string `url:"labels_to_be_notified,omitempty" json:"labels_to_be_notified,omitempty"`
	LabelsToBeNotifiedBehavior *string `url:"labels_to_be_notified_behavior,omitempty" json:"labels_to_be_notified_behavior,omitempty"`
	NotifyOnlyDefaultBranch    *bool   `url:"notify_only_default_branch,omitempty" json:"notify_only_default_branch,omitempty"`
	UseInheritedSettings       *bool   `url:"use_inherited_settings,omitempty" json:"use_inherited_settings,omitempty"`
}

GroupMattermostIntegrationOptions represents the available options for creating or updating a Mattermost integration for a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-notifications

type GroupMattermostIntegrationProperties added in v1.17.0 

type GroupMattermostIntegrationProperties struct {
	WebHook                  string `json:"webhook"`
	Username                 string `json:"username"`
	Channel                  string `json:"channel"`
	PushChannel              string `json:"push_channel"`
	IssueChannel             string `json:"issue_channel"`
	ConfidentialIssueChannel string `json:"confidential_issue_channel"`
	MergeRequestChannel      string `json:"merge_request_channel"`
	NoteChannel              string `json:"note_channel"`
	ConfidentialNoteChannel  string `json:"confidential_note_channel"`
	TagPushChannel           string `json:"tag_push_channel"`
	PipelineChannel          string `json:"pipeline_channel"`
	WikiPageChannel          string `json:"wiki_page_channel"`
	DeploymentChannel        string `json:"deployment_channel"`
	AlertChannel             string `json:"alert_channel"`
	VulnerabilityChannel     string `json:"vulnerability_channel"`
}

type GroupMattermostSlashCommandsIntegration added in v1.17.0 

type GroupMattermostSlashCommandsIntegration struct {
	ID        int        `json:"id"`
	Title     string     `json:"title"`
	Slug      string     `json:"slug"`
	CreatedAt *time.Time `json:"created_at"`
	UpdatedAt *time.Time `json:"updated_at"`
	Token     string     `json:"token"`
}

GroupMattermostSlashCommandsIntegration represents a Mattermost slash commands integration for a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands

type GroupMattermostSlashCommandsIntegrationOptions added in v1.17.0 

type GroupMattermostSlashCommandsIntegrationOptions struct {
	Token                *string `url:"token,omitempty" json:"token,omitempty"`
	UseInheritedSettings *bool   `url:"use_inherited_settings,omitempty" json:"use_inherited_settings,omitempty"`
}

GroupMattermostSlashCommandsIntegrationOptions represents the available options for creating or updating a Mattermost slash commands integration for a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands

type GroupMember 

type GroupMember struct {
	ID                int64                    `json:"id"`
	Username          string                   `json:"username"`
	Name              string                   `json:"name"`
	State             string                   `json:"state"`
	AvatarURL         string                   `json:"avatar_url"`
	WebURL            string                   `json:"web_url"`
	CreatedAt         *time.Time               `json:"created_at"`
	CreatedBy         *MemberCreatedBy         `json:"created_by"`
	ExpiresAt         *ISOTime                 `json:"expires_at"`
	AccessLevel       AccessLevelValue         `json:"access_level"`
	Email             string                   `json:"email,omitempty"`
	PublicEmail       string                   `json:"public_email,omitempty"`
	GroupSAMLIdentity *GroupMemberSAMLIdentity `json:"group_saml_identity"`
	MemberRole        *MemberRole              `json:"member_role"`
	IsUsingSeat       bool                     `json:"is_using_seat,omitempty"`
}

GroupMember represents a GitLab group member.

GitLab API docs: https://docs.gitlab.com/api/members/

type GroupMemberSAMLIdentity added in v0.116.0 

type GroupMemberSAMLIdentity struct {
	ExternUID      string `json:"extern_uid"`
	Provider       string `json:"provider"`
	SAMLProviderID int64  `json:"saml_provider_id"`
}

GroupMemberSAMLIdentity represents the SAML Identity link for the group member.

GitLab API docs: https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project

type GroupMembersService added in v0.7.0 

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

GroupMembersService handles communication with the group members related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/members/

func (*GroupMembersService) AddGroupMember added in v0.7.0 

func (s *GroupMembersService) AddGroupMember(gid any, opt *AddGroupMemberOptions, options ...RequestOptionFunc) (*GroupMember, *Response, error)

func (*GroupMembersService) DeleteShareWithGroup added in v0.116.0 

func (s *GroupMembersService) DeleteShareWithGroup(gid any, groupID int64, options ...RequestOptionFunc) (*Response, error)

func (*GroupMembersService) EditGroupMember added in v0.7.0 

func (s *GroupMembersService) EditGroupMember(gid any, user int64, opt *EditGroupMemberOptions, options ...RequestOptionFunc) (*GroupMember, *Response, error)

func (*GroupMembersService) GetGroupMember added in v0.7.0 

func (s *GroupMembersService) GetGroupMember(gid any, user int64, options ...RequestOptionFunc) (*GroupMember, *Response, error)

func (*GroupMembersService) GetInheritedGroupMember added in v0.116.0 

func (s *GroupMembersService) GetInheritedGroupMember(gid any, user int64, options ...RequestOptionFunc) (*GroupMember, *Response, error)

func (*GroupMembersService) RemoveGroupMember added in v0.7.0 

func (s *GroupMembersService) RemoveGroupMember(gid any, user int64, opt *RemoveGroupMemberOptions, options ...RequestOptionFunc) (*Response, error)

func (*GroupMembersService) ShareWithGroup added in v0.116.0 

func (s *GroupMembersService) ShareWithGroup(gid any, opt *ShareWithGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)

type GroupMembersServiceInterface added in v0.126.0 

type GroupMembersServiceInterface interface {
	// GetGroupMember gets a member of a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/members/#get-a-member-of-a-group-or-project
	GetGroupMember(gid any, user int64, options ...RequestOptionFunc) (*GroupMember, *Response, error)
	// GetInheritedGroupMember gets a member of a group or project, including
	// inherited and invited members
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/members/#get-a-member-of-a-group-or-project-including-inherited-and-invited-members
	GetInheritedGroupMember(gid any, user int64, options ...RequestOptionFunc) (*GroupMember, *Response, error)
	// AddGroupMember adds a user to the list of group members.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/members/#add-a-member-to-a-group-or-project
	AddGroupMember(gid any, opt *AddGroupMemberOptions, options ...RequestOptionFunc) (*GroupMember, *Response, error)
	// ShareWithGroup shares a group with the group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/groups/#create-a-link-to-share-a-group-with-another-group
	ShareWithGroup(gid any, opt *ShareWithGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)
	// DeleteShareWithGroup allows to unshare a group from a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/groups/#delete-the-link-that-shares-a-group-with-another-group
	DeleteShareWithGroup(gid any, groupID int64, options ...RequestOptionFunc) (*Response, error)
	// EditGroupMember updates a member of a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/members/#edit-a-member-of-a-group-or-project
	EditGroupMember(gid any, user int64, opt *EditGroupMemberOptions, options ...RequestOptionFunc) (*GroupMember, *Response, error)
	// RemoveGroupMember removes user from user team.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/members/#remove-a-member-from-a-group-or-project
	RemoveGroupMember(gid any, user int64, opt *RemoveGroupMemberOptions, options ...RequestOptionFunc) (*Response, error)
}

type GroupMilestone added in v0.10.0 

type GroupMilestone struct {
	ID          int64      `json:"id"`
	IID         int64      `json:"iid"`
	GroupID     int64      `json:"group_id"`
	Title       string     `json:"title"`
	Description string     `json:"description"`
	StartDate   *ISOTime   `json:"start_date"`
	DueDate     *ISOTime   `json:"due_date"`
	State       string     `json:"state"`
	UpdatedAt   *time.Time `json:"updated_at"`
	CreatedAt   *time.Time `json:"created_at"`
	Expired     *bool      `json:"expired"`
}

GroupMilestone represents a GitLab milestone.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/

func (GroupMilestone) String added in v0.10.0 

func (m GroupMilestone) String() string

type GroupMilestonesService added in v0.10.0 

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

GroupMilestonesService handles communication with the milestone related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/

func (*GroupMilestonesService) CreateGroupMilestone added in v0.10.0 

func (s *GroupMilestonesService) CreateGroupMilestone(gid any, opt *CreateGroupMilestoneOptions, options ...RequestOptionFunc) (*GroupMilestone, *Response, error)

CreateGroupMilestone creates a new group milestone.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#create-new-milestone

func (*GroupMilestonesService) DeleteGroupMilestone added in v0.116.0 

func (s *GroupMilestonesService) DeleteGroupMilestone(pid any, milestone int64, options ...RequestOptionFunc) (*Response, error)

DeleteGroupMilestone deletes a specified group milestone.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#delete-group-milestone

func (*GroupMilestonesService) GetGroupMilestone added in v0.10.0 

func (s *GroupMilestonesService) GetGroupMilestone(gid any, milestone int64, options ...RequestOptionFunc) (*GroupMilestone, *Response, error)

GetGroupMilestone gets a single group milestone.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#get-single-milestone

func (*GroupMilestonesService) GetGroupMilestoneBurndownChartEvents added in v0.116.0 

func (s *GroupMilestonesService) GetGroupMilestoneBurndownChartEvents(gid any, milestone int64, opt *GetGroupMilestoneBurndownChartEventsOptions, options ...RequestOptionFunc) ([]*BurndownChartEvent, *Response, error)

GetGroupMilestoneBurndownChartEvents gets all merge requests assigned to a single group milestone.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#get-all-burndown-chart-events-for-a-single-milestone

func (*GroupMilestonesService) GetGroupMilestoneIssues added in v0.10.0 

func (s *GroupMilestonesService) GetGroupMilestoneIssues(gid any, milestone int64, opt *GetGroupMilestoneIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)

GetGroupMilestoneIssues gets all issues assigned to a single group milestone.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#get-all-issues-assigned-to-a-single-milestone

func (*GroupMilestonesService) GetGroupMilestoneMergeRequests added in v0.10.0 

func (s *GroupMilestonesService) GetGroupMilestoneMergeRequests(gid any, milestone int64, opt *GetGroupMilestoneMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)

GetGroupMilestoneMergeRequests gets all merge requests assigned to a single group milestone.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#get-all-merge-requests-assigned-to-a-single-milestone

func (*GroupMilestonesService) ListGroupMilestones added in v0.10.0 

func (s *GroupMilestonesService) ListGroupMilestones(gid any, opt *ListGroupMilestonesOptions, options ...RequestOptionFunc) ([]*GroupMilestone, *Response, error)

ListGroupMilestones returns a list of group milestones.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#list-group-milestones

func (*GroupMilestonesService) UpdateGroupMilestone added in v0.10.0 

func (s *GroupMilestonesService) UpdateGroupMilestone(gid any, milestone int64, opt *UpdateGroupMilestoneOptions, options ...RequestOptionFunc) (*GroupMilestone, *Response, error)

UpdateGroupMilestone updates an existing group milestone.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#edit-milestone

type GroupMilestonesServiceInterface added in v0.126.0 

type GroupMilestonesServiceInterface interface {
	ListGroupMilestones(gid any, opt *ListGroupMilestonesOptions, options ...RequestOptionFunc) ([]*GroupMilestone, *Response, error)
	GetGroupMilestone(gid any, milestone int64, options ...RequestOptionFunc) (*GroupMilestone, *Response, error)
	CreateGroupMilestone(gid any, opt *CreateGroupMilestoneOptions, options ...RequestOptionFunc) (*GroupMilestone, *Response, error)
	UpdateGroupMilestone(gid any, milestone int64, opt *UpdateGroupMilestoneOptions, options ...RequestOptionFunc) (*GroupMilestone, *Response, error)
	DeleteGroupMilestone(pid any, milestone int64, options ...RequestOptionFunc) (*Response, error)
	GetGroupMilestoneIssues(gid any, milestone int64, opt *GetGroupMilestoneIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)
	GetGroupMilestoneMergeRequests(gid any, milestone int64, opt *GetGroupMilestoneMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)
	GetGroupMilestoneBurndownChartEvents(gid any, milestone int64, opt *GetGroupMilestoneBurndownChartEventsOptions, options ...RequestOptionFunc) ([]*BurndownChartEvent, *Response, error)
}

type GroupPackage added in v0.116.0 

type GroupPackage struct {
	Package
	ProjectID   int64  `json:"project_id"`
	ProjectPath string `json:"project_path"`
}

GroupPackage represents a GitLab group package.

GitLab API docs: https://docs.gitlab.com/api/packages/

func (GroupPackage) String added in v0.116.0 

func (s GroupPackage) String() string

type GroupPersonalAccessToken added in v1.2.0 

type GroupPersonalAccessToken struct {
	ID          int64      `json:"id"`
	Name        string     `json:"name"`
	Revoked     bool       `json:"revoked"`
	CreatedAt   *time.Time `json:"created_at"`
	Description string     `json:"description"`
	Scopes      []string   `json:"scopes"`
	UserID      int64      `json:"user_id"`
	LastUsedAt  *time.Time `json:"last_used_at,omitempty"`
	Active      bool       `json:"active"`
	ExpiresAt   *ISOTime   `json:"expires_at"`
}

GroupPersonalAccessToken represents a group enterprise users personal access token.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-all-personal-access-tokens-for-a-group

type GroupProtectedBranch added in v1.23.0 

type GroupProtectedBranch struct {
	ID                        int64                           `json:"id"`
	Name                      string                          `json:"name"`
	PushAccessLevels          []*GroupBranchAccessDescription `json:"push_access_levels"`
	MergeAccessLevels         []*GroupBranchAccessDescription `json:"merge_access_levels"`
	UnprotectAccessLevels     []*GroupBranchAccessDescription `json:"unprotect_access_levels"`
	AllowForcePush            bool                            `json:"allow_force_push"`
	CodeOwnerApprovalRequired bool                            `json:"code_owner_approval_required"`
}

GroupProtectedBranch represents a group protected branch.

GitLab API docs: https://docs.gitlab.com/api/group_protected_branches/#list-protected-branches

type GroupProtectedBranchesService added in v1.23.0 

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

GroupProtectedBranchesService handles communication with the group-level protected branch methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_protected_branches/

func (*GroupProtectedBranchesService) GetProtectedBranch added in v1.23.0 

func (s *GroupProtectedBranchesService) GetProtectedBranch(gid any, branch string, options ...RequestOptionFunc) (*GroupProtectedBranch, *Response, error)

func (*GroupProtectedBranchesService) ListProtectedBranches added in v1.23.0 

func (s *GroupProtectedBranchesService) ListProtectedBranches(gid any, opt *ListGroupProtectedBranchesOptions, options ...RequestOptionFunc) ([]*GroupProtectedBranch, *Response, error)

func (*GroupProtectedBranchesService) ProtectRepositoryBranches added in v1.23.0 

func (s *GroupProtectedBranchesService) ProtectRepositoryBranches(gid any, opt *ProtectGroupRepositoryBranchesOptions, options ...RequestOptionFunc) (*GroupProtectedBranch, *Response, error)

func (*GroupProtectedBranchesService) UnprotectRepositoryBranches added in v1.23.0 

func (s *GroupProtectedBranchesService) UnprotectRepositoryBranches(gid any, branch string, options ...RequestOptionFunc) (*Response, error)

func (*GroupProtectedBranchesService) UpdateProtectedBranch added in v1.23.0 

func (s *GroupProtectedBranchesService) UpdateProtectedBranch(gid any, branch string, opt *UpdateGroupProtectedBranchOptions, options ...RequestOptionFunc) (*GroupProtectedBranch, *Response, error)

type GroupProtectedBranchesServiceInterface added in v1.23.0 

type GroupProtectedBranchesServiceInterface interface {
	// ListProtectedBranches returns a list of protected branches from a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_protected_branches/#list-protected-branches
	ListProtectedBranches(gid any, opt *ListGroupProtectedBranchesOptions, options ...RequestOptionFunc) ([]*GroupProtectedBranch, *Response, error)

	// GetProtectedBranch returns a single group-level protected branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_protected_branches/#get-a-single-protected-branch-or-wildcard-protected-branch
	GetProtectedBranch(gid any, branch string, options ...RequestOptionFunc) (*GroupProtectedBranch, *Response, error)

	// ProtectRepositoryBranches protects a single group-level branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_protected_branches/#protect-repository-branches
	ProtectRepositoryBranches(gid any, opt *ProtectGroupRepositoryBranchesOptions, options ...RequestOptionFunc) (*GroupProtectedBranch, *Response, error)

	// UpdateProtectedBranch updates a single group-level protected branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_protected_branches/#update-a-protected-branch
	UpdateProtectedBranch(gid any, branch string, opt *UpdateGroupProtectedBranchOptions, options ...RequestOptionFunc) (*GroupProtectedBranch, *Response, error)

	// UnprotectRepositoryBranches unprotects the given protected group-level branch.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_protected_branches/#unprotect-repository-branches
	UnprotectRepositoryBranches(gid any, branch string, options ...RequestOptionFunc) (*Response, error)
}

type GroupProtectedEnvironment added in v0.116.0 

type GroupProtectedEnvironment struct {
	Name                  string                               `json:"name"`
	DeployAccessLevels    []*GroupEnvironmentAccessDescription `json:"deploy_access_levels"`
	RequiredApprovalCount int64                                `json:"required_approval_count"`
	ApprovalRules         []*GroupEnvironmentApprovalRule      `json:"approval_rules"`
}

GroupProtectedEnvironment represents a group-level protected environment.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/

type GroupProtectedEnvironmentsService added in v0.116.0 

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

GroupProtectedEnvironmentsService handles communication with the group-level protected environment methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/

func (*GroupProtectedEnvironmentsService) GetGroupProtectedEnvironment added in v0.116.0 

func (s *GroupProtectedEnvironmentsService) GetGroupProtectedEnvironment(gid any, environment string, options ...RequestOptionFunc) (*GroupProtectedEnvironment, *Response, error)

GetGroupProtectedEnvironment returns a single group-level protected environment.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/#get-a-single-protected-environment

func (*GroupProtectedEnvironmentsService) ListGroupProtectedEnvironments added in v0.116.0 

func (s *GroupProtectedEnvironmentsService) ListGroupProtectedEnvironments(gid any, opt *ListGroupProtectedEnvironmentsOptions, options ...RequestOptionFunc) ([]*GroupProtectedEnvironment, *Response, error)

ListGroupProtectedEnvironments returns a list of protected environments from a group.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/#list-group-level-protected-environments

func (*GroupProtectedEnvironmentsService) ProtectGroupEnvironment added in v0.116.0 

func (s *GroupProtectedEnvironmentsService) ProtectGroupEnvironment(gid any, opt *ProtectGroupEnvironmentOptions, options ...RequestOptionFunc) (*GroupProtectedEnvironment, *Response, error)

ProtectGroupEnvironment protects a single group-level environment.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/#protect-a-single-environment

func (*GroupProtectedEnvironmentsService) UnprotectGroupEnvironment added in v0.116.0 

func (s *GroupProtectedEnvironmentsService) UnprotectGroupEnvironment(gid any, environment string, options ...RequestOptionFunc) (*Response, error)

UnprotectGroupEnvironment unprotects the given protected group-level environment.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/#unprotect-a-single-environment

func (*GroupProtectedEnvironmentsService) UpdateGroupProtectedEnvironment added in v0.116.0 

func (s *GroupProtectedEnvironmentsService) UpdateGroupProtectedEnvironment(gid any, environment string, opt *UpdateGroupProtectedEnvironmentOptions, options ...RequestOptionFunc) (*GroupProtectedEnvironment, *Response, error)

UpdateGroupProtectedEnvironment updates a single group-level protected environment.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/#update-a-protected-environment

type GroupProtectedEnvironmentsServiceInterface added in v0.126.0 

type GroupProtectedEnvironmentsServiceInterface interface {
	ListGroupProtectedEnvironments(gid any, opt *ListGroupProtectedEnvironmentsOptions, options ...RequestOptionFunc) ([]*GroupProtectedEnvironment, *Response, error)
	GetGroupProtectedEnvironment(gid any, environment string, options ...RequestOptionFunc) (*GroupProtectedEnvironment, *Response, error)
	ProtectGroupEnvironment(gid any, opt *ProtectGroupEnvironmentOptions, options ...RequestOptionFunc) (*GroupProtectedEnvironment, *Response, error)
	UpdateGroupProtectedEnvironment(gid any, environment string, opt *UpdateGroupProtectedEnvironmentOptions, options ...RequestOptionFunc) (*GroupProtectedEnvironment, *Response, error)
	UnprotectGroupEnvironment(gid any, environment string, options ...RequestOptionFunc) (*Response, error)
}

type GroupPushRules added in v0.116.0 

type GroupPushRules struct {
	ID                         int64      `json:"id"`
	CreatedAt                  *time.Time `json:"created_at"`
	CommitMessageRegex         string     `json:"commit_message_regex"`
	CommitMessageNegativeRegex string     `json:"commit_message_negative_regex"`
	BranchNameRegex            string     `json:"branch_name_regex"`
	DenyDeleteTag              bool       `json:"deny_delete_tag"`
	MemberCheck                bool       `json:"member_check"`
	PreventSecrets             bool       `json:"prevent_secrets"`
	AuthorEmailRegex           string     `json:"author_email_regex"`
	FileNameRegex              string     `json:"file_name_regex"`
	MaxFileSize                int64      `json:"max_file_size"`
	CommitCommitterCheck       bool       `json:"commit_committer_check"`
	CommitCommitterNameCheck   bool       `json:"commit_committer_name_check"`
	RejectUnsignedCommits      bool       `json:"reject_unsigned_commits"`
	RejectNonDCOCommits        bool       `json:"reject_non_dco_commits"`
}

GroupPushRules represents a group push rule.

GitLab API docs: https://docs.gitlab.com/api/group_push_rules/#get-the-push-rules-of-a-group

type GroupRelationStatus added in v0.155.0 

type GroupRelationStatus struct {
	Relation     string    `json:"relation"`
	Status       int64     `json:"status"`
	Error        string    `json:"error"`
	UpdatedAt    time.Time `json:"updated_at"`
	Batched      bool      `json:"batched"`
	BatchesCount int64     `json:"batches_count"`
	Batches      []Batch   `json:"batches,omitempty"`
}

type GroupRelationsDownloadOptions added in v0.155.0 

type GroupRelationsDownloadOptions struct {
	Relation    *string `url:"relation,omitempty" json:"relation,omitempty"`
	Batched     *bool   `url:"batched,omitempty" json:"batched,omitempty"`
	BatchNumber *int64  `url:"batch_number,omitempty" json:"batch_number,omitempty"`
}

GroupRelationsDownloadOptions represents the available ExportDownload() options.

GitLab API docs: https://docs.gitlab.com/api/group_relations_export/#download-exported-relations

type GroupRelationsExportService added in v0.155.0 

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

GroupRelationsExportService handles communication with the group relations export related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_relations_export

func (*GroupRelationsExportService) ExportDownload added in v0.155.0 

func (s *GroupRelationsExportService) ExportDownload(gid any, opt *GroupRelationsDownloadOptions, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)

func (*GroupRelationsExportService) ListExportStatus added in v0.155.0 

func (s *GroupRelationsExportService) ListExportStatus(gid any, opt *ListGroupRelationsStatusOptions, options ...RequestOptionFunc) ([]*GroupRelationStatus, *Response, error)

func (*GroupRelationsExportService) ScheduleExport added in v0.155.0 

func (s *GroupRelationsExportService) ScheduleExport(gid any, opt *GroupRelationsScheduleExportOptions, options ...RequestOptionFunc) (*Response, error)

type GroupRelationsExportServiceInterface added in v0.155.0 

type GroupRelationsExportServiceInterface interface {
	// ScheduleExport schedules a new export of group relations.
	//
	// GitLab API docs: https://docs.gitlab.com/api/group_relations_export/#schedule-new-export
	ScheduleExport(gid any, opt *GroupRelationsScheduleExportOptions, options ...RequestOptionFunc) (*Response, error)
	// ListExportStatus gets the status of group relations export.
	//
	// GitLab API docs: https://docs.gitlab.com/api/group_relations_export/#export-status
	ListExportStatus(gid any, opt *ListGroupRelationsStatusOptions, options ...RequestOptionFunc) ([]*GroupRelationStatus, *Response, error)
	// ExportDownload downloads the exported group relations.
	//
	// GitLab API docs: https://docs.gitlab.com/api/group_relations_export/#download-exported-relations
	ExportDownload(gid any, opt *GroupRelationsDownloadOptions, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)
}

type GroupRelationsScheduleExportOptions added in v0.155.0 

type GroupRelationsScheduleExportOptions struct {
	Batched *bool `url:"batched,omitempty" json:"batched,omitempty"`
}

GroupRelationsScheduleExportOptions represents the available ScheduleExport() options.

GitLab API docs: https://docs.gitlab.com/api/group_relations_export/#schedule-new-export

type GroupReleasesService added in v0.124.0 

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

GroupReleasesService handles communication with the group releases related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_releases.html

func (*GroupReleasesService) ListGroupReleases added in v0.124.0 

func (s *GroupReleasesService) ListGroupReleases(gid any, opts *ListGroupReleasesOptions, options ...RequestOptionFunc) ([]*Release, *Response, error)

ListGroupReleases gets a list of releases for a group.

GitLab API docs: https://docs.gitlab.com/api/group_releases.html#list-group-releases

type GroupReleasesServiceInterface added in v0.126.0 

type GroupReleasesServiceInterface interface {
	ListGroupReleases(gid any, opts *ListGroupReleasesOptions, options ...RequestOptionFunc) ([]*Release, *Response, error)
}

type GroupRepositoryStorageMove added in v0.116.0 

type GroupRepositoryStorageMove struct {
	ID                     int64            `json:"id"`
	CreatedAt              *time.Time       `json:"created_at"`
	State                  string           `json:"state"`
	SourceStorageName      string           `json:"source_storage_name"`
	DestinationStorageName string           `json:"destination_storage_name"`
	Group                  *RepositoryGroup `json:"group"`
}

GroupRepositoryStorageMove represents the status of a repository move.

GitLab API docs: https://docs.gitlab.com/api/group_repository_storage_moves/

type GroupRepositoryStorageMoveService added in v0.116.0 

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

GroupRepositoryStorageMoveService handles communication with the group repositories related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_repository_storage_moves/

func (GroupRepositoryStorageMoveService) GetStorageMove added in v0.116.0 

func (g GroupRepositoryStorageMoveService) GetStorageMove(repositoryStorage int64, options ...RequestOptionFunc) (*GroupRepositoryStorageMove, *Response, error)

GetStorageMove gets a single group repository storage move.

GitLab API docs: https://docs.gitlab.com/api/group_repository_storage_moves/#get-a-single-group-repository-storage-move

func (GroupRepositoryStorageMoveService) GetStorageMoveForGroup added in v0.116.0 

func (g GroupRepositoryStorageMoveService) GetStorageMoveForGroup(group int64, repositoryStorage int64, options ...RequestOptionFunc) (*GroupRepositoryStorageMove, *Response, error)

GetStorageMoveForGroup gets a single repository storage move for a group.

GitLab API docs: https://docs.gitlab.com/api/group_repository_storage_moves/#get-a-single-repository-storage-move-for-a-group

func (GroupRepositoryStorageMoveService) RetrieveAllStorageMoves added in v0.116.0 

func (g GroupRepositoryStorageMoveService) RetrieveAllStorageMoves(opts RetrieveAllGroupStorageMovesOptions, options ...RequestOptionFunc) ([]*GroupRepositoryStorageMove, *Response, error)

RetrieveAllStorageMoves retrieves all group repository storage moves accessible by the authenticated user.

GitLab API docs: https://docs.gitlab.com/api/group_repository_storage_moves/#retrieve-all-group-repository-storage-moves

func (GroupRepositoryStorageMoveService) RetrieveAllStorageMovesForGroup added in v0.116.0 

func (g GroupRepositoryStorageMoveService) RetrieveAllStorageMovesForGroup(group int64, opts RetrieveAllGroupStorageMovesOptions, options ...RequestOptionFunc) ([]*GroupRepositoryStorageMove, *Response, error)

RetrieveAllStorageMovesForGroup retrieves all repository storage moves for a single group accessible by the authenticated user.

GitLab API docs: https://docs.gitlab.com/api/group_repository_storage_moves/#retrieve-all-repository-storage-moves-for-a-single-group

func (GroupRepositoryStorageMoveService) ScheduleAllStorageMoves added in v0.116.0 

func (g GroupRepositoryStorageMoveService) ScheduleAllStorageMoves(opts ScheduleAllGroupStorageMovesOptions, options ...RequestOptionFunc) (*Response, error)

ScheduleAllStorageMoves schedules all group repositories to be moved.

GitLab API docs: https://docs.gitlab.com/api/group_repository_storage_moves/#schedule-repository-storage-moves-for-all-groups-on-a-storage-shard

func (GroupRepositoryStorageMoveService) ScheduleStorageMoveForGroup added in v0.116.0 

func (g GroupRepositoryStorageMoveService) ScheduleStorageMoveForGroup(group int64, opts ScheduleStorageMoveForGroupOptions, options ...RequestOptionFunc) (*GroupRepositoryStorageMove, *Response, error)

ScheduleStorageMoveForGroup schedule a repository to be moved for a group.

GitLab API docs: https://docs.gitlab.com/api/group_repository_storage_moves/#schedule-a-repository-storage-move-for-a-group

type GroupRepositoryStorageMoveServiceInterface added in v0.126.0 

type GroupRepositoryStorageMoveServiceInterface interface {
	RetrieveAllStorageMoves(opts RetrieveAllGroupStorageMovesOptions, options ...RequestOptionFunc) ([]*GroupRepositoryStorageMove, *Response, error)
	RetrieveAllStorageMovesForGroup(group int64, opts RetrieveAllGroupStorageMovesOptions, options ...RequestOptionFunc) ([]*GroupRepositoryStorageMove, *Response, error)
	GetStorageMove(repositoryStorage int64, options ...RequestOptionFunc) (*GroupRepositoryStorageMove, *Response, error)
	GetStorageMoveForGroup(group int64, repositoryStorage int64, options ...RequestOptionFunc) (*GroupRepositoryStorageMove, *Response, error)
	ScheduleStorageMoveForGroup(group int64, opts ScheduleStorageMoveForGroupOptions, options ...RequestOptionFunc) (*GroupRepositoryStorageMove, *Response, error)
	ScheduleAllStorageMoves(opts ScheduleAllGroupStorageMovesOptions, options ...RequestOptionFunc) (*Response, error)
}

type GroupResourceAccessTokenEvent added in v0.116.0 

type GroupResourceAccessTokenEvent struct {
	EventName        string                                        `json:"event_name"`
	ObjectKind       string                                        `json:"object_kind"`
	Group            GroupResourceAccessTokenEventGroup            `json:"group"`
	ObjectAttributes GroupResourceAccessTokenEventObjectAttributes `json:"object_attributes"`
}

GroupResourceAccessTokenEvent represents a resource access token event for a group.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#project-and-group-access-token-events

type GroupResourceAccessTokenEventGroup added in v1.0.0 

type GroupResourceAccessTokenEventGroup struct {
	GroupID   int64  `json:"group_id"`
	GroupName string `json:"group_name"`
	GroupPath string `json:"group_path"`
	FullPath  string `json:"full_path"`
}

GroupResourceAccessTokenEventGroup represents a group in a resource access token event.

type GroupResourceAccessTokenEventObjectAttributes added in v1.0.0 

type GroupResourceAccessTokenEventObjectAttributes struct {
	ID        int64    `json:"id"`
	UserID    int64    `json:"user_id"`
	Name      string   `json:"name"`
	CreatedAt string   `json:"created_at"`
	ExpiresAt *ISOTime `json:"expires_at"`
}

type GroupSCIMIdentity added in v0.124.0 

type GroupSCIMIdentity struct {
	ExternalUID string `json:"external_uid"`
	UserID      int64  `json:"user_id"`
	Active      bool   `json:"active"`
}

GroupSCIMIdentity represents a GitLab Group SCIM identity.

GitLab API docs: https://docs.gitlab.com/api/scim/

type GroupSCIMService added in v0.124.0 

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

GroupSCIMService handles communication with the Group SCIM related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/scim/

func (*GroupSCIMService) DeleteSCIMIdentity added in v0.124.0 

func (s *GroupSCIMService) DeleteSCIMIdentity(gid any, uid string, options ...RequestOptionFunc) (*Response, error)

DeleteSCIMIdentity deletes a SCIM identity.

GitLab API docs: https://docs.gitlab.com/api/scim/#delete-a-single-scim-identity

func (*GroupSCIMService) GetSCIMIdentitiesForGroup added in v0.124.0 

func (s *GroupSCIMService) GetSCIMIdentitiesForGroup(gid any, options ...RequestOptionFunc) ([]*GroupSCIMIdentity, *Response, error)

GetSCIMIdentitiesForGroup gets all SCIM identities for a group.

GitLab API docs: https://docs.gitlab.com/api/scim/#get-scim-identities-for-a-group

func (*GroupSCIMService) GetSCIMIdentity added in v0.124.0 

func (s *GroupSCIMService) GetSCIMIdentity(gid any, uid string, options ...RequestOptionFunc) (*GroupSCIMIdentity, *Response, error)

GetSCIMIdentity gets a SCIM identity for a group.

GitLab API docs: https://docs.gitlab.com/api/scim/#get-a-single-scim-identity

func (*GroupSCIMService) UpdateSCIMIdentity added in v0.124.0 

func (s *GroupSCIMService) UpdateSCIMIdentity(gid any, uid string, opt *UpdateSCIMIdentityOptions, options ...RequestOptionFunc) (*Response, error)

UpdateSCIMIdentity updates a SCIM identity.

GitLab API docs: https://docs.gitlab.com/api/scim/#update-extern_uid-field-for-a-scim-identity

type GroupSCIMServiceInterface added in v0.126.0 

type GroupSCIMServiceInterface interface {
	GetSCIMIdentitiesForGroup(gid any, options ...RequestOptionFunc) ([]*GroupSCIMIdentity, *Response, error)
	GetSCIMIdentity(gid any, uid string, options ...RequestOptionFunc) (*GroupSCIMIdentity, *Response, error)
	UpdateSCIMIdentity(gid any, uid string, opt *UpdateSCIMIdentityOptions, options ...RequestOptionFunc) (*Response, error)
	DeleteSCIMIdentity(gid any, uid string, options ...RequestOptionFunc) (*Response, error)
}

type GroupSSHCertificate added in v0.116.0 

type GroupSSHCertificate struct {
	ID        int64      `json:"id"`
	Title     string     `json:"title"`
	Key       string     `json:"key"`
	CreatedAt *time.Time `json:"created_at"`
}

GroupSSHCertificate represents a GitLab Group SSH certificate.

GitLab API docs: https://docs.gitlab.com/api/group_ssh_certificates/

type GroupSSHCertificatesService added in v0.116.0 

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

GroupSSHCertificatesService handles communication with the group SSH certificate related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_ssh_certificates/

func (*GroupSSHCertificatesService) CreateGroupSSHCertificate added in v0.116.0 

func (s *GroupSSHCertificatesService) CreateGroupSSHCertificate(gid any, opt *CreateGroupSSHCertificateOptions, options ...RequestOptionFunc) (*GroupSSHCertificate, *Response, error)

CreateGroupSSHCertificate creates a new SSH certificate in the group.

GitLab API docs: https://docs.gitlab.com/api/group_ssh_certificates/#create-ssh-certificate

func (*GroupSSHCertificatesService) DeleteGroupSSHCertificate added in v0.116.0 

func (s *GroupSSHCertificatesService) DeleteGroupSSHCertificate(gid any, cert int64, options ...RequestOptionFunc) (*Response, error)

DeleteGroupSSHCertificate deletes a SSH certificate from a specified group.

GitLab API docs: https://docs.gitlab.com/api/group_ssh_certificates/#delete-group-ssh-certificate

func (*GroupSSHCertificatesService) ListGroupSSHCertificates added in v0.116.0 

func (s *GroupSSHCertificatesService) ListGroupSSHCertificates(gid any, options ...RequestOptionFunc) ([]*GroupSSHCertificate, *Response, error)

ListGroupSSHCertificates gets a list of SSH certificates for a specified group.

GitLab API docs: https://docs.gitlab.com/api/group_ssh_certificates/#get-all-ssh-certificates-for-a-particular-group

type GroupSSHCertificatesServiceInterface added in v0.126.0 

type GroupSSHCertificatesServiceInterface interface {
	ListGroupSSHCertificates(gid any, options ...RequestOptionFunc) ([]*GroupSSHCertificate, *Response, error)
	CreateGroupSSHCertificate(gid any, opt *CreateGroupSSHCertificateOptions, options ...RequestOptionFunc) (*GroupSSHCertificate, *Response, error)
	DeleteGroupSSHCertificate(gid any, cert int64, options ...RequestOptionFunc) (*Response, error)
}

GroupSSHCertificatesServiceInterface defines methods for the GroupSSHCertificatesService.

type GroupSSHKey added in v1.3.0 

type GroupSSHKey struct {
	ID         int64      `json:"id"`
	Title      string     `json:"title"`
	CreatedAt  *time.Time `json:"created_at"`
	ExpiresAt  *time.Time `json:"expires_at"`
	LastUsedAt *time.Time `json:"last_used_at"`
	UsageType  string     `json:"usage_type"`
	UserID     int64      `json:"user_id"`
}

GroupSSHKey represents a group enterprise users public SSH key.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-all-ssh-keys-for-a-group

type GroupSecuritySettings added in v0.121.0 

type GroupSecuritySettings struct {
	SecretPushProtectionEnabled bool     `json:"secret_push_protection_enabled"`
	Errors                      []string `json:"errors"`
}

GroupSecuritySettings represents the group security settings data.

GitLab API docs: https://docs.gitlab.com/api/group_security_settings/

func (GroupSecuritySettings) String added in v0.121.0 

func (s GroupSecuritySettings) String() string

String gets a string representation of the GroupSecuritySettings data.

GitLab API docs: https://docs.gitlab.com/api/group_security_settings/

type GroupSecuritySettingsService added in v0.121.0 

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

GroupSecuritySettingsService handles communication with the Group Security Settings related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_security_settings/

func (*GroupSecuritySettingsService) UpdateSecretPushProtectionEnabledSetting added in v0.121.0 

func (s *GroupSecuritySettingsService) UpdateSecretPushProtectionEnabledSetting(gid any, opt UpdateGroupSecuritySettingsOptions, options ...RequestOptionFunc) (*GroupSecuritySettings, *Response, error)

UpdateSecretPushProtectionEnabledSetting updates the secret_push_protection_enabled setting for the all projects in a group to the provided value.

GitLab API Docs: https://docs.gitlab.com/api/group_security_settings/#update-secret_push_protection_enabled-setting

type GroupSecuritySettingsServiceInterface added in v0.126.0 

type GroupSecuritySettingsServiceInterface interface {
	UpdateSecretPushProtectionEnabledSetting(gid any, opt UpdateGroupSecuritySettingsOptions, options ...RequestOptionFunc) (*GroupSecuritySettings, *Response, error)
}

type GroupServiceAccount added in v0.116.0 

type GroupServiceAccount struct {
	ID       int64  `json:"id"`
	Name     string `json:"name"`
	UserName string `json:"username"`
	Email    string `json:"email"`
}

GroupServiceAccount represents a GitLab service account user.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#create-a-group-service-account

type GroupSystemEvent added in v0.116.0 

type GroupSystemEvent struct {
	BaseSystemEvent
	Name                 string `json:"name"`
	Path                 string `json:"path"`
	PathWithNamespace    string `json:"full_path"`
	GroupID              int64  `json:"group_id"`
	OwnerName            string `json:"owner_name"`
	OwnerEmail           string `json:"owner_email"`
	ProjectVisibility    string `json:"project_visibility"`
	OldPath              string `json:"old_path,omitempty"`
	OldPathWithNamespace string `json:"old_full_path,omitempty"`
}

GroupSystemEvent represents a group system event.

GitLab API docs: https://docs.gitlab.com/administration/system_hooks/

type GroupVariable added in v0.11.0 

type GroupVariable struct {
	Key              string            `json:"key"`
	Value            string            `json:"value"`
	VariableType     VariableTypeValue `json:"variable_type"`
	Protected        bool              `json:"protected"`
	Masked           bool              `json:"masked"`
	Hidden           bool              `json:"hidden"`
	Raw              bool              `json:"raw"`
	EnvironmentScope string            `json:"environment_scope"`
	Description      string            `json:"description"`
}

GroupVariable represents a GitLab group Variable.

GitLab API docs: https://docs.gitlab.com/api/group_level_variables/

func (GroupVariable) String added in v0.11.0 

func (v GroupVariable) String() string

type GroupVariablesService added in v0.11.0 

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

GroupVariablesService handles communication with the group variables related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_level_variables/

func (*GroupVariablesService) CreateVariable added in v0.11.0 

func (s *GroupVariablesService) CreateVariable(gid any, opt *CreateGroupVariableOptions, options ...RequestOptionFunc) (*GroupVariable, *Response, error)

func (*GroupVariablesService) GetVariable added in v0.11.0 

func (s *GroupVariablesService) GetVariable(gid any, key string, opt *GetGroupVariableOptions, options ...RequestOptionFunc) (*GroupVariable, *Response, error)

func (*GroupVariablesService) ListVariables added in v0.11.0 

func (s *GroupVariablesService) ListVariables(gid any, opt *ListGroupVariablesOptions, options ...RequestOptionFunc) ([]*GroupVariable, *Response, error)

func (*GroupVariablesService) RemoveVariable added in v0.11.0 

func (s *GroupVariablesService) RemoveVariable(gid any, key string, opt *RemoveGroupVariableOptions, options ...RequestOptionFunc) (*Response, error)

func (*GroupVariablesService) UpdateVariable added in v0.11.0 

func (s *GroupVariablesService) UpdateVariable(gid any, key string, opt *UpdateGroupVariableOptions, options ...RequestOptionFunc) (*GroupVariable, *Response, error)

type GroupVariablesServiceInterface added in v0.126.0 

type GroupVariablesServiceInterface interface {
	// ListVariables gets a list of all variables for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_level_variables/#list-group-variables
	ListVariables(gid any, opt *ListGroupVariablesOptions, options ...RequestOptionFunc) ([]*GroupVariable, *Response, error)
	// GetVariable gets a variable.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_level_variables/#show-variable-details
	GetVariable(gid any, key string, opt *GetGroupVariableOptions, options ...RequestOptionFunc) (*GroupVariable, *Response, error)
	// CreateVariable creates a new group variable.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_level_variables/#create-variable
	CreateVariable(gid any, opt *CreateGroupVariableOptions, options ...RequestOptionFunc) (*GroupVariable, *Response, error)
	// UpdateVariable updates an existing group variable.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_level_variables/#update-variable
	UpdateVariable(gid any, key string, opt *UpdateGroupVariableOptions, options ...RequestOptionFunc) (*GroupVariable, *Response, error)
	// RemoveVariable removes a group's variable.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_level_variables/#remove-variable
	RemoveVariable(gid any, key string, opt *RemoveGroupVariableOptions, options ...RequestOptionFunc) (*Response, error)
}

GroupVariablesServiceInterface defines methods for the GroupVariablesService.

type GroupWiki added in v0.116.0 

type GroupWiki struct {
	Content  string          `json:"content"`
	Encoding string          `json:"encoding"`
	Format   WikiFormatValue `json:"format"`
	Slug     string          `json:"slug"`
	Title    string          `json:"title"`
}

GroupWiki represents a GitLab groups wiki.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/

func (GroupWiki) String added in v0.116.0 

func (w GroupWiki) String() string

type GroupWikisService added in v0.116.0 

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

GroupWikisService handles communication with the group wikis related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/

func (*GroupWikisService) CreateGroupWikiPage added in v0.116.0 

func (s *GroupWikisService) CreateGroupWikiPage(gid any, opt *CreateGroupWikiPageOptions, options ...RequestOptionFunc) (*GroupWiki, *Response, error)

CreateGroupWikiPage creates a new wiki page for the given group with the given title, slug, and content.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/#create-a-new-wiki-page

func (*GroupWikisService) DeleteGroupWikiPage added in v0.116.0 

func (s *GroupWikisService) DeleteGroupWikiPage(gid any, slug string, options ...RequestOptionFunc) (*Response, error)

DeleteGroupWikiPage deletes a wiki page with a given slug.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/#delete-a-wiki-page

func (*GroupWikisService) EditGroupWikiPage added in v0.116.0 

func (s *GroupWikisService) EditGroupWikiPage(gid any, slug string, opt *EditGroupWikiPageOptions, options ...RequestOptionFunc) (*GroupWiki, *Response, error)

EditGroupWikiPage Updates an existing wiki page. At least one parameter is required to update the wiki page.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/#edit-an-existing-wiki-page

func (*GroupWikisService) GetGroupWikiPage added in v0.116.0 

func (s *GroupWikisService) GetGroupWikiPage(gid any, slug string, opt *GetGroupWikiPageOptions, options ...RequestOptionFunc) (*GroupWiki, *Response, error)

GetGroupWikiPage gets a wiki page for a given group.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/#get-a-wiki-page

func (*GroupWikisService) ListGroupWikis added in v0.116.0 

func (s *GroupWikisService) ListGroupWikis(gid any, opt *ListGroupWikisOptions, options ...RequestOptionFunc) ([]*GroupWiki, *Response, error)

ListGroupWikis lists all pages of the wiki of the given group id. When with_content is set, it also returns the content of the pages.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/#list-wiki-pages

type GroupWikisServiceInterface added in v0.126.0 

type GroupWikisServiceInterface interface {
	ListGroupWikis(gid any, opt *ListGroupWikisOptions, options ...RequestOptionFunc) ([]*GroupWiki, *Response, error)
	GetGroupWikiPage(gid any, slug string, opt *GetGroupWikiPageOptions, options ...RequestOptionFunc) (*GroupWiki, *Response, error)
	CreateGroupWikiPage(gid any, opt *CreateGroupWikiPageOptions, options ...RequestOptionFunc) (*GroupWiki, *Response, error)
	EditGroupWikiPage(gid any, slug string, opt *EditGroupWikiPageOptions, options ...RequestOptionFunc) (*GroupWiki, *Response, error)
	DeleteGroupWikiPage(gid any, slug string, options ...RequestOptionFunc) (*Response, error)
}

GroupWikisServiceInterface defines methods for the GroupWikisService.

type GroupsService 

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

GroupsService handles communication with the group related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/groups/

func (*GroupsService) AddGroupHook added in v0.116.0 

func (s *GroupsService) AddGroupHook(gid any, opt *AddGroupHookOptions, options ...RequestOptionFunc) (*GroupHook, *Response, error)

AddGroupHook creates a new group scoped webhook.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#add-a-group-hook 

func (s *GroupsService) AddGroupLDAPLink(gid any, opt *AddGroupLDAPLinkOptions, options ...RequestOptionFunc) (*LDAPGroupLink, *Response, error)

AddGroupLDAPLink creates a new group LDAP link. Available only for users who can edit groups.

GitLab API docs: https://docs.gitlab.com/api/group_ldap_links/#add-an-ldap-group-link-with-cn-or-filter

func (*GroupsService) AddGroupPushRule added in v0.116.0 

func (s *GroupsService) AddGroupPushRule(gid any, opt *AddGroupPushRuleOptions, options ...RequestOptionFunc) (*GroupPushRules, *Response, error)

AddGroupPushRule adds push rules to the specified group.

GitLab API docs: https://docs.gitlab.com/api/group_push_rules/#add-push-rules-to-a-group 

func (s *GroupsService) AddGroupSAMLLink(gid any, opt *AddGroupSAMLLinkOptions, options ...RequestOptionFunc) (*SAMLGroupLink, *Response, error)

AddGroupSAMLLink creates a new group SAML link. Available only for users who can edit groups.

GitLab API docs: https://docs.gitlab.com/api/saml/#add-a-saml-group-link

func (*GroupsService) CreateGroup 

func (s *GroupsService) CreateGroup(opt *CreateGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)

CreateGroup creates a new project group. Available only for users who can create groups.

When `default_branch_protection_defaults` are defined with an `avatar` value, only one value for `allowed_to_push` and `allowed_to_merge` will be used as the GitLab API only accepts one value for those attributes even when multiples are provided on the request. The API will take the highest permission level. For instance, if 'developer' and 'maintainer' are provided, the API will take 'maintainer'.

GitLab API docs: https://docs.gitlab.com/api/groups/#create-a-group

func (*GroupsService) CreateServiceAccount added in v0.116.0 

func (s *GroupsService) CreateServiceAccount(gid any, opt *CreateServiceAccountOptions, options ...RequestOptionFunc) (*GroupServiceAccount, *Response, error)

CreateServiceAccount creates a service account user.

This API endpoint works on top-level groups only. It does not work on subgroups.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#create-a-group-service-account

func (*GroupsService) CreateServiceAccountPersonalAccessToken added in v0.116.0 

func (s *GroupsService) CreateServiceAccountPersonalAccessToken(gid any, serviceAccount int64, opt *CreateServiceAccountPersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)

CreateServiceAccountPersonalAccessToken add a new Personal Access Token for a service account user for a group.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#create-a-personal-access-token-for-a-group-service-account

func (*GroupsService) DeleteGroup 

func (s *GroupsService) DeleteGroup(gid any, opt *DeleteGroupOptions, options ...RequestOptionFunc) (*Response, error)

DeleteGroup removes group with all projects inside.

GitLab API docs: https://docs.gitlab.com/api/groups/#delete-a-group

func (*GroupsService) DeleteGroupCustomHeader added in v0.116.0 

func (s *GroupsService) DeleteGroupCustomHeader(gid any, hook int64, key string, options ...RequestOptionFunc) (*Response, error)

DeleteGroupCustomHeader deletes a group custom webhook header.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#delete-a-custom-header

func (*GroupsService) DeleteGroupHook added in v0.116.0 

func (s *GroupsService) DeleteGroupHook(gid any, hook int64, options ...RequestOptionFunc) (*Response, error)

DeleteGroupHook removes a hook from a group. This is an idempotent method and can be called multiple times.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#delete-a-group-hook

func (*GroupsService) DeleteGroupHookURLVariable added in v0.124.0 

func (s *GroupsService) DeleteGroupHookURLVariable(gid any, hook int64, key string, options ...RequestOptionFunc) (*Response, error)

DeleteGroupHookURLVariable sets a group hook URL variable.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#delete-a-url-variable 

func (s *GroupsService) DeleteGroupLDAPLink(gid any, cn string, options ...RequestOptionFunc) (*Response, error)

DeleteGroupLDAPLink deletes a group LDAP link. Available only for users who can edit groups. Deprecated as upstream API is deprecated. Use DeleteGroupLDAPLinkWithCNOrFilter() instead.

GitLab API docs: https://docs.gitlab.com/api/group_ldap_links/#delete-an-ldap-group-link-deprecated

func (*GroupsService) DeleteGroupLDAPLinkForProvider added in v0.116.0 

func (s *GroupsService) DeleteGroupLDAPLinkForProvider(gid any, provider, cn string, options ...RequestOptionFunc) (*Response, error)

DeleteGroupLDAPLinkForProvider deletes a group LDAP link from a specific provider. Available only for users who can edit groups.

GitLab API docs: https://docs.gitlab.com/api/group_ldap_links/#delete-an-ldap-group-link-deprecated

func (*GroupsService) DeleteGroupLDAPLinkWithCNOrFilter added in v0.116.0 

func (s *GroupsService) DeleteGroupLDAPLinkWithCNOrFilter(gid any, opts *DeleteGroupLDAPLinkWithCNOrFilterOptions, options ...RequestOptionFunc) (*Response, error)

DeleteGroupLDAPLinkWithCNOrFilter deletes a group LDAP link. Available only for users who can edit groups.

GitLab API docs: https://docs.gitlab.com/api/group_ldap_links/#delete-an-ldap-group-link-with-cn-or-filter

func (*GroupsService) DeleteGroupPushRule added in v0.116.0 

func (s *GroupsService) DeleteGroupPushRule(gid any, options ...RequestOptionFunc) (*Response, error)

DeleteGroupPushRule deletes the push rules of a group.

GitLab API docs: https://docs.gitlab.com/api/group_push_rules/#delete-the-push-rules-of-a-group 

func (s *GroupsService) DeleteGroupSAMLLink(gid any, samlGroupName string, options ...RequestOptionFunc) (*Response, error)

DeleteGroupSAMLLink deletes a group SAML link. Available only for users who can edit groups.

GitLab API docs: https://docs.gitlab.com/api/saml/#delete-a-saml-group-link

func (*GroupsService) DeleteServiceAccount added in v0.116.0 

func (s *GroupsService) DeleteServiceAccount(gid any, serviceAccount int64, opt *DeleteServiceAccountOptions, options ...RequestOptionFunc) (*Response, error)

DeleteServiceAccount Deletes a service account user.

This API endpoint works on top-level groups only. It does not work on subgroups.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#delete-a-group-service-account

func (*GroupsService) DownloadAvatar added in v0.116.0 

func (s *GroupsService) DownloadAvatar(gid any, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)

DownloadAvatar downloads a group avatar.

GitLab API docs: https://docs.gitlab.com/api/groups/#download-a-group-avatar

func (*GroupsService) EditGroupHook added in v0.116.0 

func (s *GroupsService) EditGroupHook(gid any, hook int64, opt *EditGroupHookOptions, options ...RequestOptionFunc) (*GroupHook, *Response, error)

EditGroupHook edits a hook for a specified group.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#edit-group-hook

func (*GroupsService) EditGroupPushRule added in v0.116.0 

func (s *GroupsService) EditGroupPushRule(gid any, opt *EditGroupPushRuleOptions, options ...RequestOptionFunc) (*GroupPushRules, *Response, error)

EditGroupPushRule edits a push rule for a specified group.

GitLab API docs: https://docs.gitlab.com/api/group_push_rules/#edit-the-push-rules-of-a-group

func (*GroupsService) GetGroup 

func (s *GroupsService) GetGroup(gid any, opt *GetGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)

GetGroup gets all details of a group.

GitLab API docs: https://docs.gitlab.com/api/groups/#get-a-single-group

func (*GroupsService) GetGroupHook added in v0.116.0 

func (s *GroupsService) GetGroupHook(gid any, hook int64, options ...RequestOptionFunc) (*GroupHook, *Response, error)

GetGroupHook gets a specific hook for a group.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#get-a-group-hook

func (*GroupsService) GetGroupPushRules added in v0.116.0 

func (s *GroupsService) GetGroupPushRules(gid any, options ...RequestOptionFunc) (*GroupPushRules, *Response, error)

GetGroupPushRules gets the push rules of a group.

GitLab API docs: https://docs.gitlab.com/api/group_push_rules/#get-the-push-rules-of-a-group 

func (s *GroupsService) GetGroupSAMLLink(gid any, samlGroupName string, options ...RequestOptionFunc) (*SAMLGroupLink, *Response, error)

GetGroupSAMLLink get a specific group SAML link. Available only for users who can edit groups.

GitLab API docs: https://docs.gitlab.com/api/saml/#get-a-saml-group-link

func (*GroupsService) ListAllGroupMembers added in v0.11.2 

func (s *GroupsService) ListAllGroupMembers(gid any, opt *ListGroupMembersOptions, options ...RequestOptionFunc) ([]*GroupMember, *Response, error)

ListAllGroupMembers get a list of group members viewable by the authenticated user. Returns a list including inherited members through ancestor groups.

GitLab API docs: https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project-including-inherited-and-invited-members

func (*GroupsService) ListBillableGroupMembers added in v0.116.0 

func (s *GroupsService) ListBillableGroupMembers(gid any, opt *ListBillableGroupMembersOptions, options ...RequestOptionFunc) ([]*BillableGroupMember, *Response, error)

ListBillableGroupMembers Gets a list of group members that count as billable. The list includes members in the subgroup or subproject.

GitLab API docs: https://docs.gitlab.com/api/members/#list-all-billable-members-of-a-group

func (*GroupsService) ListDescendantGroups added in v0.116.0 

func (s *GroupsService) ListDescendantGroups(gid any, opt *ListDescendantGroupsOptions, options ...RequestOptionFunc) ([]*Group, *Response, error)

ListDescendantGroups gets a list of subgroups for a given project.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-descendant-groups

func (*GroupsService) ListGroupHooks added in v0.116.0 

func (s *GroupsService) ListGroupHooks(gid any, opt *ListGroupHooksOptions, options ...RequestOptionFunc) ([]*GroupHook, *Response, error)

ListGroupHooks gets a list of group hooks.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#list-group-hooks 

func (s *GroupsService) ListGroupLDAPLinks(gid any, options ...RequestOptionFunc) ([]*LDAPGroupLink, *Response, error)

ListGroupLDAPLinks lists the group's LDAP links. Available only for users who can edit groups.

GitLab API docs: https://docs.gitlab.com/api/group_ldap_links/#list-ldap-group-links

func (*GroupsService) ListGroupMembers 

func (s *GroupsService) ListGroupMembers(gid any, opt *ListGroupMembersOptions, options ...RequestOptionFunc) ([]*GroupMember, *Response, error)

ListGroupMembers get a list of group members viewable by the authenticated user. Inherited members through ancestor groups are not included.

GitLab API docs: https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project

func (*GroupsService) ListGroupProjects added in v0.4.0 

func (s *GroupsService) ListGroupProjects(gid any, opt *ListGroupProjectsOptions, options ...RequestOptionFunc) ([]*Project, *Response, error)

ListGroupProjects get a list of group projects

GitLab API docs: https://docs.gitlab.com/api/groups/#list-projects 

func (s *GroupsService) ListGroupSAMLLinks(gid any, options ...RequestOptionFunc) ([]*SAMLGroupLink, *Response, error)

ListGroupSAMLLinks lists the group's SAML links. Available only for users who can edit groups.

GitLab API docs: https://docs.gitlab.com/api/saml/#list-saml-group-links

func (*GroupsService) ListGroupSharedProjects added in v0.125.0 

func (s *GroupsService) ListGroupSharedProjects(gid any, opt *ListGroupSharedProjectsOptions, options ...RequestOptionFunc) ([]*Project, *Response, error)

ListGroupSharedProjects gets a list of projects shared to this group.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-shared-projects

func (*GroupsService) ListGroups 

func (s *GroupsService) ListGroups(opt *ListGroupsOptions, options ...RequestOptionFunc) ([]*Group, *Response, error)

ListGroups gets a list of groups (as user: my groups, as admin: all groups).

GitLab API docs: https://docs.gitlab.com/api/groups/#list-groups

func (*GroupsService) ListMembershipsForBillableGroupMember added in v0.116.0 

func (s *GroupsService) ListMembershipsForBillableGroupMember(gid any, user int64, opt *ListMembershipsForBillableGroupMemberOptions, options ...RequestOptionFunc) ([]*BillableUserMembership, *Response, error)

ListMembershipsForBillableGroupMember gets a list of memberships for a billable member of a group.

GitLab API docs: https://docs.gitlab.com/api/members/#list-memberships-for-a-billable-member-of-a-group

func (*GroupsService) ListProvisionedUsers added in v0.116.0 

func (s *GroupsService) ListProvisionedUsers(gid any, opt *ListProvisionedUsersOptions, options ...RequestOptionFunc) ([]*User, *Response, error)

ListProvisionedUsers gets a list of users provisioned by the given group.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-provisioned-users

func (*GroupsService) ListServiceAccountPersonalAccessTokens added in v0.132.0 

func (s *GroupsService) ListServiceAccountPersonalAccessTokens(gid any, serviceAccount int64, opt *ListServiceAccountPersonalAccessTokensOptions, options ...RequestOptionFunc) ([]*PersonalAccessToken, *Response, error)

ListServiceAccountPersonalAccessTokens gets a list of personal access tokens for a service account user for a group.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#list-all-personal-access-tokens-for-a-group-service-account

func (*GroupsService) ListServiceAccounts added in v0.116.0 

func (s *GroupsService) ListServiceAccounts(gid any, opt *ListServiceAccountsOptions, options ...RequestOptionFunc) ([]*GroupServiceAccount, *Response, error)

ListServiceAccounts gets a list of service accounts.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#list-all-group-service-accounts

func (*GroupsService) ListSubGroups added in v0.116.0 

func (s *GroupsService) ListSubGroups(gid any, opt *ListSubGroupsOptions, options ...RequestOptionFunc) ([]*Group, *Response, error)

ListSubGroups gets a list of subgroups for a given group.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-subgroups

func (*GroupsService) RemoveBillableGroupMember added in v0.116.0 

func (s *GroupsService) RemoveBillableGroupMember(gid any, user int64, options ...RequestOptionFunc) (*Response, error)

RemoveBillableGroupMember removes a given group members that count as billable.

GitLab API docs: https://docs.gitlab.com/api/members/#remove-a-billable-member-from-a-group

func (*GroupsService) ResendGroupHookEvent added in v0.124.0 

func (s *GroupsService) ResendGroupHookEvent(gid any, hook int64, hookEventID int64, options ...RequestOptionFunc) (*Response, error)

ResendGroupHookEvent resends a specific hook event.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#resend-group-hook-event

func (*GroupsService) RestoreGroup added in v0.116.0 

func (s *GroupsService) RestoreGroup(gid any, options ...RequestOptionFunc) (*Group, *Response, error)

RestoreGroup restores a previously deleted group

GitLab API docs: https://docs.gitlab.com/api/groups/#restore-a-group-marked-for-deletion

func (*GroupsService) RevokeServiceAccountPersonalAccessToken added in v0.132.0 

func (s *GroupsService) RevokeServiceAccountPersonalAccessToken(gid any, serviceAccount, token int64, options ...RequestOptionFunc) (*Response, error)

RevokeServiceAccountPersonalAccessToken revokes a personal access token for an existing service account user in a given top-level group.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#revoke-a-personal-access-token-for-a-group-service-account

func (*GroupsService) RotateServiceAccountPersonalAccessToken added in v0.116.0 

func (s *GroupsService) RotateServiceAccountPersonalAccessToken(gid any, serviceAccount, token int64, opt *RotateServiceAccountPersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)

RotateServiceAccountPersonalAccessToken rotates a Personal Access Token for a service account user for a group.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#rotate-a-personal-access-token-for-a-group-service-account

func (*GroupsService) SearchGroup 

func (s *GroupsService) SearchGroup(query string, options ...RequestOptionFunc) ([]*Group, *Response, error)

SearchGroup get all groups that match your string in their name or path.

GitLab API docs: https://docs.gitlab.com/api/groups/#search-for-a-group

func (*GroupsService) SetGroupCustomHeader added in v0.116.0 

func (s *GroupsService) SetGroupCustomHeader(gid any, hook int64, key string, opt *SetHookCustomHeaderOptions, options ...RequestOptionFunc) (*Response, error)

SetGroupCustomHeader creates or updates a group custom webhook header.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#set-a-custom-header

func (*GroupsService) SetGroupHookURLVariable added in v0.124.0 

func (s *GroupsService) SetGroupHookURLVariable(gid any, hook int64, key string, opt *SetHookURLVariableOptions, options ...RequestOptionFunc) (*Response, error)

SetGroupHookURLVariable sets a group hook URL variable.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#set-a-url-variable

func (*GroupsService) ShareGroupWithGroup added in v0.116.0 

func (s *GroupsService) ShareGroupWithGroup(gid any, opt *ShareGroupWithGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)

ShareGroupWithGroup shares a group with another group.

GitLab API docs: https://docs.gitlab.com/api/groups/#create-a-link-to-share-a-group-with-another-group

func (*GroupsService) TransferGroup 

func (s *GroupsService) TransferGroup(gid any, pid any, options ...RequestOptionFunc) (*Group, *Response, error)

TransferGroup transfers a project to the Group namespace. Available only for admin.

GitLab API docs: https://docs.gitlab.com/api/groups/#transfer-a-project-to-a-group

func (*GroupsService) TransferSubGroup added in v0.116.0 

func (s *GroupsService) TransferSubGroup(gid any, opt *TransferSubGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)

TransferSubGroup transfers a group to a new parent group or turn a subgroup to a top-level group. Available to administrators and users.

GitLab API docs: https://docs.gitlab.com/api/groups/#transfer-a-group

func (*GroupsService) TriggerTestGroupHook added in v0.116.0 

func (s *GroupsService) TriggerTestGroupHook(pid any, hook int64, trigger GroupHookTrigger, options ...RequestOptionFunc) (*Response, error)

TriggerTestGroupHook triggers a test hook for a specified group.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#trigger-a-test-group-hook

func (*GroupsService) UnshareGroupFromGroup added in v0.116.0 

func (s *GroupsService) UnshareGroupFromGroup(gid any, groupID int64, options ...RequestOptionFunc) (*Response, error)

UnshareGroupFromGroup unshares a group from another group.

GitLab API docs: https://docs.gitlab.com/api/groups/#delete-the-link-that-shares-a-group-with-another-group

func (*GroupsService) UpdateGroup added in v0.6.0 

func (s *GroupsService) UpdateGroup(gid any, opt *UpdateGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)

UpdateGroup updates an existing group; only available to group owners and administrators.

When `default_branch_protection_defaults` are defined with an `avatar` value, only one value for `allowed_to_push` and `allowed_to_merge` will be used as the GitLab API only accepts one value for those attributes even when multiples are provided on the request. The API will take the highest permission level. For instance, if 'developer' and 'maintainer' are provided, the API will take 'maintainer'.

GitLab API docs: https://docs.gitlab.com/api/groups/#update-group-attributes

func (*GroupsService) UpdateServiceAccount added in v0.132.0 

func (s *GroupsService) UpdateServiceAccount(gid any, serviceAccount int64, opt *UpdateServiceAccountOptions, options ...RequestOptionFunc) (*GroupServiceAccount, *Response, error)

UpdateServiceAccount updates a service account user.

This API endpoint works on top-level groups only. It does not work on subgroups.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#update-a-group-service-account

func (*GroupsService) UploadAvatar added in v0.116.0 

func (s *GroupsService) UploadAvatar(gid any, avatar io.Reader, filename string, options ...RequestOptionFunc) (*Group, *Response, error)

UploadAvatar uploads a group avatar.

GitLab API docs: https://docs.gitlab.com/api/groups/#upload-a-group-avatar

type GroupsServiceInterface added in v0.126.0 

type GroupsServiceInterface interface {
	ListGroups(opt *ListGroupsOptions, options ...RequestOptionFunc) ([]*Group, *Response, error)
	ListSubGroups(gid any, opt *ListSubGroupsOptions, options ...RequestOptionFunc) ([]*Group, *Response, error)
	ListDescendantGroups(gid any, opt *ListDescendantGroupsOptions, options ...RequestOptionFunc) ([]*Group, *Response, error)
	ListGroupProjects(gid any, opt *ListGroupProjectsOptions, options ...RequestOptionFunc) ([]*Project, *Response, error)
	GetGroup(gid any, opt *GetGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)
	DownloadAvatar(gid any, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)
	CreateGroup(opt *CreateGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)
	TransferGroup(gid any, pid any, options ...RequestOptionFunc) (*Group, *Response, error)
	TransferSubGroup(gid any, opt *TransferSubGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)
	UpdateGroup(gid any, opt *UpdateGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)
	UploadAvatar(gid any, avatar io.Reader, filename string, options ...RequestOptionFunc) (*Group, *Response, error)
	DeleteGroup(gid any, opt *DeleteGroupOptions, options ...RequestOptionFunc) (*Response, error)
	RestoreGroup(gid any, options ...RequestOptionFunc) (*Group, *Response, error)
	SearchGroup(query string, options ...RequestOptionFunc) ([]*Group, *Response, error)
	ListProvisionedUsers(gid any, opt *ListProvisionedUsersOptions, options ...RequestOptionFunc) ([]*User, *Response, error)
	ListGroupLDAPLinks(gid any, options ...RequestOptionFunc) ([]*LDAPGroupLink, *Response, error)
	AddGroupLDAPLink(gid any, opt *AddGroupLDAPLinkOptions, options ...RequestOptionFunc) (*LDAPGroupLink, *Response, error)
	DeleteGroupLDAPLink(gid any, cn string, options ...RequestOptionFunc) (*Response, error)
	DeleteGroupLDAPLinkWithCNOrFilter(gid any, opts *DeleteGroupLDAPLinkWithCNOrFilterOptions, options ...RequestOptionFunc) (*Response, error)
	DeleteGroupLDAPLinkForProvider(gid any, provider, cn string, options ...RequestOptionFunc) (*Response, error)
	ListGroupSAMLLinks(gid any, options ...RequestOptionFunc) ([]*SAMLGroupLink, *Response, error)
	ListGroupSharedProjects(gid any, opt *ListGroupSharedProjectsOptions, options ...RequestOptionFunc) ([]*Project, *Response, error)
	GetGroupSAMLLink(gid any, samlGroupName string, options ...RequestOptionFunc) (*SAMLGroupLink, *Response, error)
	AddGroupSAMLLink(gid any, opt *AddGroupSAMLLinkOptions, options ...RequestOptionFunc) (*SAMLGroupLink, *Response, error)
	DeleteGroupSAMLLink(gid any, samlGroupName string, options ...RequestOptionFunc) (*Response, error)
	ShareGroupWithGroup(gid any, opt *ShareGroupWithGroupOptions, options ...RequestOptionFunc) (*Group, *Response, error)
	UnshareGroupFromGroup(gid any, groupID int64, options ...RequestOptionFunc) (*Response, error)
	GetGroupPushRules(gid any, options ...RequestOptionFunc) (*GroupPushRules, *Response, error)
	AddGroupPushRule(gid any, opt *AddGroupPushRuleOptions, options ...RequestOptionFunc) (*GroupPushRules, *Response, error)
	EditGroupPushRule(gid any, opt *EditGroupPushRuleOptions, options ...RequestOptionFunc) (*GroupPushRules, *Response, error)
	DeleteGroupPushRule(gid any, options ...RequestOptionFunc) (*Response, error)

	// group_hooks.go
	ListGroupHooks(gid any, opt *ListGroupHooksOptions, options ...RequestOptionFunc) ([]*GroupHook, *Response, error)
	GetGroupHook(gid any, hook int64, options ...RequestOptionFunc) (*GroupHook, *Response, error)
	ResendGroupHookEvent(gid any, hook int64, hookEventID int64, options ...RequestOptionFunc) (*Response, error)
	AddGroupHook(gid any, opt *AddGroupHookOptions, options ...RequestOptionFunc) (*GroupHook, *Response, error)
	EditGroupHook(gid any, hook int64, opt *EditGroupHookOptions, options ...RequestOptionFunc) (*GroupHook, *Response, error)
	DeleteGroupHook(gid any, hook int64, options ...RequestOptionFunc) (*Response, error)
	TriggerTestGroupHook(pid any, hook int64, trigger GroupHookTrigger, options ...RequestOptionFunc) (*Response, error)
	SetGroupCustomHeader(gid any, hook int64, key string, opt *SetHookCustomHeaderOptions, options ...RequestOptionFunc) (*Response, error)
	DeleteGroupCustomHeader(gid any, hook int64, key string, options ...RequestOptionFunc) (*Response, error)
	SetGroupHookURLVariable(gid any, hook int64, key string, opt *SetHookURLVariableOptions, options ...RequestOptionFunc) (*Response, error)
	DeleteGroupHookURLVariable(gid any, hook int64, key string, options ...RequestOptionFunc) (*Response, error)

	// group_serviceaccounts.go
	ListServiceAccounts(gid any, opt *ListServiceAccountsOptions, options ...RequestOptionFunc) ([]*GroupServiceAccount, *Response, error)
	CreateServiceAccount(gid any, opt *CreateServiceAccountOptions, options ...RequestOptionFunc) (*GroupServiceAccount, *Response, error)
	UpdateServiceAccount(gid any, serviceAccount int64, opt *UpdateServiceAccountOptions, options ...RequestOptionFunc) (*GroupServiceAccount, *Response, error)
	DeleteServiceAccount(gid any, serviceAccount int64, opt *DeleteServiceAccountOptions, options ...RequestOptionFunc) (*Response, error)
	ListServiceAccountPersonalAccessTokens(gid any, serviceAccount int64, opt *ListServiceAccountPersonalAccessTokensOptions, options ...RequestOptionFunc) ([]*PersonalAccessToken, *Response, error)
	CreateServiceAccountPersonalAccessToken(gid any, serviceAccount int64, opt *CreateServiceAccountPersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)
	RevokeServiceAccountPersonalAccessToken(gid any, serviceAccount, token int64, options ...RequestOptionFunc) (*Response, error)
	RotateServiceAccountPersonalAccessToken(gid any, serviceAccount, token int64, opt *RotateServiceAccountPersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)

	// group_members.go
	ListGroupMembers(gid any, opt *ListGroupMembersOptions, options ...RequestOptionFunc) ([]*GroupMember, *Response, error)
	ListAllGroupMembers(gid any, opt *ListGroupMembersOptions, options ...RequestOptionFunc) ([]*GroupMember, *Response, error)
	ListBillableGroupMembers(gid any, opt *ListBillableGroupMembersOptions, options ...RequestOptionFunc) ([]*BillableGroupMember, *Response, error)
	ListMembershipsForBillableGroupMember(gid any, user int64, opt *ListMembershipsForBillableGroupMemberOptions, options ...RequestOptionFunc) ([]*BillableUserMembership, *Response, error)
	RemoveBillableGroupMember(gid any, user int64, options ...RequestOptionFunc) (*Response, error)
}

type HarborService added in v0.116.0 

type HarborService struct {
	Service
	Properties *HarborServiceProperties `json:"properties"`
}

HarborService represents the Harbor service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#harbor

type HarborServiceProperties added in v0.116.0 

type HarborServiceProperties struct {
	URL                  string `json:"url"`
	ProjectName          string `json:"project_name"`
	Username             string `json:"username"`
	Password             string `json:"password"`
	UseInheritedSettings bool   `json:"use_inherited_settings"`
}

HarborServiceProperties represents Harbor specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#harbor

type Hook 

type Hook struct {
	ID                     int64      `json:"id"`
	URL                    string     `json:"url"`
	CreatedAt              *time.Time `json:"created_at"`
	PushEvents             bool       `json:"push_events"`
	TagPushEvents          bool       `json:"tag_push_events"`
	MergeRequestsEvents    bool       `json:"merge_requests_events"`
	RepositoryUpdateEvents bool       `json:"repository_update_events"`
	EnableSSLVerification  bool       `json:"enable_ssl_verification"`
}

Hook represents a GitLab system hook.

GitLab API docs: https://docs.gitlab.com/api/system_hooks/

func (Hook) String 

func (h Hook) String() string

type HookCustomHeader added in v0.116.0 

type HookCustomHeader struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

HookCustomHeader represents a project or group hook custom header Note: "Key" is returned from the Get operation, but "Value" is not The List operation doesn't return any headers at all for Projects, but does return headers for Groups

type HookEvent 

type HookEvent struct {
	EventName  string `json:"event_name"`
	Name       string `json:"name"`
	Path       string `json:"path"`
	ProjectID  int64  `json:"project_id"`
	OwnerName  string `json:"owner_name"`
	OwnerEmail string `json:"owner_email"`
}

HookEvent represents an event trigger by a GitLab system hook.

GitLab API docs: https://docs.gitlab.com/api/system_hooks/

func (HookEvent) String 

func (h HookEvent) String() string

type HookURLVariable added in v0.138.0 

type HookURLVariable struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

HookURLVariable represents a project or group hook URL variable

type ISOTime added in v0.7.2 

type ISOTime time.Time

ISOTime represents an ISO 8601 formatted date.

func ParseISOTime added in v0.116.0 

func ParseISOTime(s string) (ISOTime, error)

ParseISOTime parses an ISO 8601 formatted date.

func (*ISOTime) EncodeValues added in v0.116.0 

func (t *ISOTime) EncodeValues(key string, v *url.Values) error

EncodeValues implements the query.Encoder interface.

func (ISOTime) MarshalJSON added in v0.7.2 

func (t ISOTime) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (ISOTime) String added in v0.9.0 

func (t ISOTime) String() string

String implements the Stringer interface.

func (*ISOTime) UnmarshalJSON added in v0.7.2 

func (t *ISOTime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type ImpersonationToken added in v0.6.0 

type ImpersonationToken struct {
	ID         int64      `json:"id"`
	Name       string     `json:"name"`
	Active     bool       `json:"active"`
	Token      string     `json:"token"`
	Scopes     []string   `json:"scopes"`
	Revoked    bool       `json:"revoked"`
	CreatedAt  *time.Time `json:"created_at"`
	ExpiresAt  *ISOTime   `json:"expires_at"`
	LastUsedAt *time.Time `json:"last_used_at"`
}

ImpersonationToken represents an impersonation token.

GitLab API docs: https://docs.gitlab.com/api/user_tokens/#list-all-impersonation-tokens-for-a-user

type ImportFileOptions added in v0.116.0 

type ImportFileOptions struct {
	Namespace      *string               `url:"namespace,omitempty" json:"namespace,omitempty"`
	Name           *string               `url:"name,omitempty" json:"name,omitempty"`
	Path           *string               `url:"path,omitempty" json:"path,omitempty"`
	Overwrite      *bool                 `url:"overwrite,omitempty" json:"overwrite,omitempty"`
	OverrideParams *CreateProjectOptions `url:"override_params,omitempty" json:"override_params,omitempty"`
}

ImportFileOptions represents the available ImportFile() options.

GitLab API docs: https://docs.gitlab.com/api/project_import_export/#import-a-file

type ImportGitHubGistsIntoGitLabSnippetsOptions added in v0.116.0 

type ImportGitHubGistsIntoGitLabSnippetsOptions struct {
	PersonalAccessToken *string `url:"personal_access_token,omitempty" json:"personal_access_token,omitempty"`
}

ImportGitHubGistsIntoGitLabSnippetsOptions represents the available ImportGitHubGistsIntoGitLabSnippets() options.

GitLab API docs: https://docs.gitlab.com/api/import/#import-github-gists-into-gitlab-snippets

type ImportRepositoryFromBitbucketCloudOptions added in v0.116.0 

type ImportRepositoryFromBitbucketCloudOptions struct {
	BitbucketUsername    *string `url:"bitbucket_username,omitempty" json:"bitbucket_username,omitempty"`
	BitbucketAppPassword *string `url:"bitbucket_app_password,omitempty" json:"bitbucket_app_password,omitempty"`
	RepoPath             *string `url:"repo_path,omitempty" json:"repo_path,omitempty"`
	TargetNamespace      *string `url:"target_namespace,omitempty" json:"target_namespace,omitempty"`
	NewName              *string `url:"new_name,omitempty" json:"new_name,omitempty"`
}

ImportRepositoryFromBitbucketCloudOptions represents the available ImportRepositoryFromBitbucketCloud() options.

GitLab API docs: https://docs.gitlab.com/api/import/#import-repository-from-bitbucket-cloud

type ImportRepositoryFromBitbucketServerOptions added in v0.116.0 

type ImportRepositoryFromBitbucketServerOptions struct {
	BitbucketServerURL      *string `url:"bitbucket_server_url,omitempty" json:"bitbucket_server_url,omitempty"`
	BitbucketServerUsername *string `url:"bitbucket_server_username,omitempty" json:"bitbucket_server_username,omitempty"`
	PersonalAccessToken     *string `url:"personal_access_token,omitempty" json:"personal_access_token,omitempty"`
	BitbucketServerProject  *string `url:"bitbucket_server_project,omitempty" json:"bitbucket_server_project,omitempty"`
	BitbucketServerRepo     *string `url:"bitbucket_server_repo,omitempty" json:"bitbucket_server_repo,omitempty"`
	NewName                 *string `url:"new_name,omitempty" json:"new_name,omitempty"`
	NewNamespace            *string `url:"new_namespace,omitempty" json:"new_namespace,omitempty"`
	TimeoutStrategy         *string `url:"timeout_strategy,omitempty" json:"timeout_strategy,omitempty"`
}

ImportRepositoryFromBitbucketServerOptions represents the available ImportRepositoryFromBitbucketServer() options.

GitLab API docs: https://docs.gitlab.com/api/import/#import-repository-from-bitbucket-server

type ImportRepositoryFromGitHubOptionalStagesOptions added in v1.0.0 

type ImportRepositoryFromGitHubOptionalStagesOptions struct {
	SingleEndpointNotesImport *bool `url:"single_endpoint_notes_import,omitempty" json:"single_endpoint_notes_import,omitempty"`
	AttachmentsImport         *bool `url:"attachments_import,omitempty" json:"attachments_import,omitempty"`
	CollaboratorsImport       *bool `url:"collaborators_import,omitempty" json:"collaborators_import,omitempty"`
}

type ImportRepositoryFromGitHubOptions added in v0.116.0 

type ImportRepositoryFromGitHubOptions struct {
	PersonalAccessToken *string                                         `url:"personal_access_token,omitempty" json:"personal_access_token,omitempty"`
	RepoID              *int64                                          `url:"repo_id,omitempty" json:"repo_id,omitempty"`
	NewName             *string                                         `url:"new_name,omitempty" json:"new_name,omitempty"`
	TargetNamespace     *string                                         `url:"target_namespace,omitempty" json:"target_namespace,omitempty"`
	GitHubHostname      *string                                         `url:"github_hostname,omitempty" json:"github_hostname,omitempty"`
	OptionalStages      ImportRepositoryFromGitHubOptionalStagesOptions `url:"optional_stages,omitempty" json:"optional_stages,omitempty"`
	TimeoutStrategy     *string                                         `url:"timeout_strategy,omitempty" json:"timeout_strategy,omitempty"`
}

ImportRepositoryFromGitHubOptions represents the available ImportRepositoryFromGitHub() options.

GitLab API docs: https://docs.gitlab.com/api/import/#import-repository-from-github

type ImportService added in v0.116.0 

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

ImportService handles communication with the import related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/import/

func (*ImportService) CancelGitHubProjectImport added in v0.116.0 

func (s *ImportService) CancelGitHubProjectImport(opt *CancelGitHubProjectImportOptions, options ...RequestOptionFunc) (*CancelledGitHubImport, *Response, error)

CancelGitHubProjectImport cancels an import of a repository from GitHub.

GitLab API docs: https://docs.gitlab.com/api/import/#cancel-github-project-import

func (*ImportService) ImportGitHubGistsIntoGitLabSnippets added in v0.116.0 

func (s *ImportService) ImportGitHubGistsIntoGitLabSnippets(opt *ImportGitHubGistsIntoGitLabSnippetsOptions, options ...RequestOptionFunc) (*Response, error)

ImportGitHubGistsIntoGitLabSnippets imports personal GitHub Gists into personal GitLab Snippets.

GitLab API docs: https://docs.gitlab.com/api/import/#import-github-gists-into-gitlab-snippets

func (*ImportService) ImportRepositoryFromBitbucketCloud added in v0.116.0 

func (s *ImportService) ImportRepositoryFromBitbucketCloud(opt *ImportRepositoryFromBitbucketCloudOptions, options ...RequestOptionFunc) (*BitbucketCloudImport, *Response, error)

ImportRepositoryFromBitbucketCloud imports a repository from Bitbucket Cloud.

GitLab API docs: https://docs.gitlab.com/api/import/#import-repository-from-bitbucket-cloud

func (*ImportService) ImportRepositoryFromBitbucketServer added in v0.116.0 

func (s *ImportService) ImportRepositoryFromBitbucketServer(opt *ImportRepositoryFromBitbucketServerOptions, options ...RequestOptionFunc) (*BitbucketServerImport, *Response, error)

ImportRepositoryFromBitbucketServer imports a repository from Bitbucket Server.

GitLab API docs: https://docs.gitlab.com/api/import/#import-repository-from-bitbucket-server

func (*ImportService) ImportRepositoryFromGitHub added in v0.116.0 

func (s *ImportService) ImportRepositoryFromGitHub(opt *ImportRepositoryFromGitHubOptions, options ...RequestOptionFunc) (*GitHubImport, *Response, error)

ImportRepositoryFromGitHub imports a repository from GitHub.

GitLab API docs: https://docs.gitlab.com/api/import/#import-repository-from-github

type ImportServiceInterface added in v0.126.0 

type ImportServiceInterface interface {
	ImportRepositoryFromGitHub(opt *ImportRepositoryFromGitHubOptions, options ...RequestOptionFunc) (*GitHubImport, *Response, error)
	CancelGitHubProjectImport(opt *CancelGitHubProjectImportOptions, options ...RequestOptionFunc) (*CancelledGitHubImport, *Response, error)
	ImportGitHubGistsIntoGitLabSnippets(opt *ImportGitHubGistsIntoGitLabSnippetsOptions, options ...RequestOptionFunc) (*Response, error)
	ImportRepositoryFromBitbucketServer(opt *ImportRepositoryFromBitbucketServerOptions, options ...RequestOptionFunc) (*BitbucketServerImport, *Response, error)
	ImportRepositoryFromBitbucketCloud(opt *ImportRepositoryFromBitbucketCloudOptions, options ...RequestOptionFunc) (*BitbucketCloudImport, *Response, error)
}

type ImportStatus added in v0.116.0 

type ImportStatus struct {
	ID                int64      `json:"id"`
	Description       string     `json:"description"`
	Name              string     `json:"name"`
	NameWithNamespace string     `json:"name_with_namespace"`
	Path              string     `json:"path"`
	PathWithNamespace string     `json:"path_with_namespace"`
	CreateAt          *time.Time `json:"create_at"`
	ImportStatus      string     `json:"import_status"`
	ImportType        string     `json:"import_type"`
	CorrelationID     string     `json:"correlation_id"`
	ImportError       string     `json:"import_error"`
}

ImportStatus represents a project import status.

GitLab API docs: https://docs.gitlab.com/api/project_import_export/#import-status

func (ImportStatus) String added in v0.116.0 

func (s ImportStatus) String() string

type Include added in v0.117.0 

type Include struct {
	Type           string         `json:"type"`
	Location       string         `json:"location"`
	Blob           string         `json:"blob"`
	Raw            string         `json:"raw"`
	Extra          map[string]any `json:"extra"`
	ContextProject string         `json:"context_project"`
	ContextSHA     string         `json:"context_sha"`
}

Include contains the details about an include block in the .gitlab-ci.yml file. It is used in ProjectLintResult.

Reference can be found at the lint API endpoint in the openapi yaml: https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi_v2.yaml

type InstanceCluster added in v0.116.0 

type InstanceCluster struct {
	ID                 int64               `json:"id"`
	Name               string              `json:"name"`
	Domain             string              `json:"domain"`
	Managed            bool                `json:"managed"`
	CreatedAt          *time.Time          `json:"created_at"`
	ProviderType       string              `json:"provider_type"`
	PlatformType       string              `json:"platform_type"`
	EnvironmentScope   string              `json:"environment_scope"`
	ClusterType        string              `json:"cluster_type"`
	User               *User               `json:"user"`
	PlatformKubernetes *PlatformKubernetes `json:"platform_kubernetes"`
	ManagementProject  *ManagementProject  `json:"management_project"`
}

InstanceCluster represents a GitLab Instance Cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/instance_clusters/

func (InstanceCluster) String deprecated added in v0.116.0 

func (v InstanceCluster) String() string

Deprecated: in GitLab 14.5, to be removed in 19.0

type InstanceClustersService added in v0.116.0 

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

InstanceClustersService handles communication with the instance clusters related methods of the GitLab API. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/instance_clusters/

func (*InstanceClustersService) AddCluster added in v0.116.0 

func (s *InstanceClustersService) AddCluster(opt *AddClusterOptions, options ...RequestOptionFunc) (*InstanceCluster, *Response, error)

AddCluster adds an existing cluster to the instance. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/instance_clusters/#add-existing-instance-cluster

func (*InstanceClustersService) DeleteCluster added in v0.116.0 

func (s *InstanceClustersService) DeleteCluster(cluster int64, options ...RequestOptionFunc) (*Response, error)

DeleteCluster deletes an existing instance cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/instance_clusters/#delete-instance-cluster

func (*InstanceClustersService) EditCluster added in v0.116.0 

func (s *InstanceClustersService) EditCluster(cluster int64, opt *EditClusterOptions, options ...RequestOptionFunc) (*InstanceCluster, *Response, error)

EditCluster updates an existing instance cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/instance_clusters/#edit-instance-cluster

func (*InstanceClustersService) GetCluster added in v0.116.0 

func (s *InstanceClustersService) GetCluster(cluster int64, options ...RequestOptionFunc) (*InstanceCluster, *Response, error)

GetCluster gets an instance cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/instance_clusters/#get-a-single-instance-cluster

func (*InstanceClustersService) ListClusters added in v0.116.0 

func (s *InstanceClustersService) ListClusters(options ...RequestOptionFunc) ([]*InstanceCluster, *Response, error)

ListClusters gets a list of all instance clusters. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/instance_clusters/#list-instance-clusters

type InstanceClustersServiceInterface deprecated added in v0.126.0 

type InstanceClustersServiceInterface interface {
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	ListClusters(options ...RequestOptionFunc) ([]*InstanceCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	GetCluster(cluster int64, options ...RequestOptionFunc) (*InstanceCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	AddCluster(opt *AddClusterOptions, options ...RequestOptionFunc) (*InstanceCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	EditCluster(cluster int64, opt *EditClusterOptions, options ...RequestOptionFunc) (*InstanceCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	DeleteCluster(cluster int64, options ...RequestOptionFunc) (*Response, error)
}

Deprecated: in GitLab 14.5, to be removed in 19.0

type InstanceDeployKey added in v0.116.0 

type InstanceDeployKey struct {
	ID                         int64               `json:"id"`
	Title                      string              `json:"title"`
	CreatedAt                  *time.Time          `json:"created_at"`
	ExpiresAt                  *time.Time          `json:"expires_at"`
	Key                        string              `json:"key"`
	Fingerprint                string              `json:"fingerprint"`
	FingerprintSHA256          string              `json:"fingerprint_sha256"`
	ProjectsWithWriteAccess    []*DeployKeyProject `json:"projects_with_write_access"`
	ProjectsWithReadonlyAccess []*DeployKeyProject `json:"projects_with_readonly_access"`
}

InstanceDeployKey represents a GitLab deploy key with the associated projects it has write access to.

func (InstanceDeployKey) String added in v0.116.0 

func (k InstanceDeployKey) String() string

type InstanceVariable added in v0.116.0 

type InstanceVariable struct {
	Key          string            `json:"key"`
	Value        string            `json:"value"`
	VariableType VariableTypeValue `json:"variable_type"`
	Protected    bool              `json:"protected"`
	Masked       bool              `json:"masked"`
	Raw          bool              `json:"raw"`
	Description  string            `json:"description"`
}

InstanceVariable represents a GitLab instance level CI Variable.

GitLab API docs: https://docs.gitlab.com/api/instance_level_ci_variables/

func (InstanceVariable) String added in v0.116.0 

func (v InstanceVariable) String() string

type InstanceVariablesService added in v0.116.0 

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

InstanceVariablesService handles communication with the instance level CI variables related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/instance_level_ci_variables/

func (*InstanceVariablesService) CreateVariable added in v0.116.0 

func (s *InstanceVariablesService) CreateVariable(opt *CreateInstanceVariableOptions, options ...RequestOptionFunc) (*InstanceVariable, *Response, error)

func (*InstanceVariablesService) GetVariable added in v0.116.0 

func (s *InstanceVariablesService) GetVariable(key string, options ...RequestOptionFunc) (*InstanceVariable, *Response, error)

func (*InstanceVariablesService) ListVariables added in v0.116.0 

func (s *InstanceVariablesService) ListVariables(opt *ListInstanceVariablesOptions, options ...RequestOptionFunc) ([]*InstanceVariable, *Response, error)

func (*InstanceVariablesService) RemoveVariable added in v0.116.0 

func (s *InstanceVariablesService) RemoveVariable(key string, options ...RequestOptionFunc) (*Response, error)

func (*InstanceVariablesService) UpdateVariable added in v0.116.0 

func (s *InstanceVariablesService) UpdateVariable(key string, opt *UpdateInstanceVariableOptions, options ...RequestOptionFunc) (*InstanceVariable, *Response, error)

type InstanceVariablesServiceInterface added in v0.126.0 

type InstanceVariablesServiceInterface interface {
	// ListVariables gets a list of all variables for an instance.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/instance_level_ci_variables/#list-all-instance-variables
	ListVariables(opt *ListInstanceVariablesOptions, options ...RequestOptionFunc) ([]*InstanceVariable, *Response, error)
	// GetVariable gets a variable.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/instance_level_ci_variables/#show-instance-variable-details
	GetVariable(key string, options ...RequestOptionFunc) (*InstanceVariable, *Response, error)
	// CreateVariable creates a new instance level CI variable.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/instance_level_ci_variables/#create-instance-variable
	CreateVariable(opt *CreateInstanceVariableOptions, options ...RequestOptionFunc) (*InstanceVariable, *Response, error)
	// UpdateVariable updates an existing instance level CI variable.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/instance_level_ci_variables/#update-instance-variable
	UpdateVariable(key string, opt *UpdateInstanceVariableOptions, options ...RequestOptionFunc) (*InstanceVariable, *Response, error)
	// RemoveVariable removes an instance level CI variable.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/instance_level_ci_variables/#remove-instance-variable
	RemoveVariable(key string, options ...RequestOptionFunc) (*Response, error)
}

type Integration added in v0.135.0 

type Integration struct {
	ID                             int64      `json:"id"`
	Title                          string     `json:"title"`
	Slug                           string     `json:"slug"`
	CreatedAt                      *time.Time `json:"created_at"`
	UpdatedAt                      *time.Time `json:"updated_at"`
	Active                         bool       `json:"active"`
	AlertEvents                    bool       `json:"alert_events"`
	CommitEvents                   bool       `json:"commit_events"`
	ConfidentialIssuesEvents       bool       `json:"confidential_issues_events"`
	ConfidentialNoteEvents         bool       `json:"confidential_note_events"`
	DeploymentEvents               bool       `json:"deployment_events"`
	GroupConfidentialMentionEvents bool       `json:"group_confidential_mention_events"`
	GroupMentionEvents             bool       `json:"group_mention_events"`
	IncidentEvents                 bool       `json:"incident_events"`
	IssuesEvents                   bool       `json:"issues_events"`
	JobEvents                      bool       `json:"job_events"`
	MergeRequestsEvents            bool       `json:"merge_requests_events"`
	NoteEvents                     bool       `json:"note_events"`
	PipelineEvents                 bool       `json:"pipeline_events"`
	PushEvents                     bool       `json:"push_events"`
	TagPushEvents                  bool       `json:"tag_push_events"`
	VulnerabilityEvents            bool       `json:"vulnerability_events"`
	WikiPageEvents                 bool       `json:"wiki_page_events"`
	CommentOnEventEnabled          bool       `json:"comment_on_event_enabled"`
	Inherited                      bool       `json:"inherited"`
}

Integration represents a GitLab group or project integration.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/ https://docs.gitlab.com/api/project_integrations/

type IntegrationsService added in v0.135.0 

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

IntegrationsService handles communication with the group integrations related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/ee/api/group_integrations.html

func (*IntegrationsService) DeleteGroupMattermostIntegration added in v1.17.0 

func (s *IntegrationsService) DeleteGroupMattermostIntegration(gid any, options ...RequestOptionFunc) (*Response, error)

DeleteGroupMattermostIntegration removes the Mattermost integration from a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-notifications

func (*IntegrationsService) DeleteGroupMattermostSlashCommandsIntegration added in v1.17.0 

func (s *IntegrationsService) DeleteGroupMattermostSlashCommandsIntegration(gid any, options ...RequestOptionFunc) (*Response, error)

DeleteGroupMattermostSlashCommandsIntegration removes the Mattermost slash commands integration from a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands

func (*IntegrationsService) DisableGroupHarbor added in v0.137.0 

func (s *IntegrationsService) DisableGroupHarbor(gid any, options ...RequestOptionFunc) (*Response, error)

func (*IntegrationsService) DisableGroupJira added in v0.159.0 

func (s *IntegrationsService) DisableGroupJira(gid any, options ...RequestOptionFunc) (*Response, error)

func (*IntegrationsService) DisableGroupMicrosoftTeamsNotifications added in v0.135.0 

func (s *IntegrationsService) DisableGroupMicrosoftTeamsNotifications(gid any, options ...RequestOptionFunc) (*Response, error)

func (*IntegrationsService) DisableGroupSlack added in v1.26.0 

func (s *IntegrationsService) DisableGroupSlack(gid any, options ...RequestOptionFunc) (*Response, error)

func (*IntegrationsService) DisableGroupWebexTeams added in v1.25.0 

func (s *IntegrationsService) DisableGroupWebexTeams(gid any, options ...RequestOptionFunc) (*Response, error)

func (*IntegrationsService) DisableProjectGoogleChat added in v1.36.0 

func (s *IntegrationsService) DisableProjectGoogleChat(pid any, options ...RequestOptionFunc) (*Response, error)

func (*IntegrationsService) GetGroupDiscordSettings added in v1.19.0 

func (s *IntegrationsService) GetGroupDiscordSettings(gid any, options ...RequestOptionFunc) (*DiscordIntegration, *Response, error)

func (*IntegrationsService) GetGroupGoogleChatSettings added in v1.19.0 

func (s *IntegrationsService) GetGroupGoogleChatSettings(gid any, options ...RequestOptionFunc) (*GoogleChatIntegration, *Response, error)

func (*IntegrationsService) GetGroupHarborSettings added in v0.137.0 

func (s *IntegrationsService) GetGroupHarborSettings(gid any, options ...RequestOptionFunc) (*Integration, *Response, error)

func (*IntegrationsService) GetGroupJiraSettings added in v0.159.0 

func (s *IntegrationsService) GetGroupJiraSettings(gid any, options ...RequestOptionFunc) (*Integration, *Response, error)

func (*IntegrationsService) GetGroupMatrixSettings added in v1.19.0 

func (s *IntegrationsService) GetGroupMatrixSettings(gid any, options ...RequestOptionFunc) (*MatrixIntegration, *Response, error)

func (*IntegrationsService) GetGroupMattermostIntegration added in v1.17.0 

func (s *IntegrationsService) GetGroupMattermostIntegration(gid any, options ...RequestOptionFunc) (*GroupMattermostIntegration, *Response, error)

GetGroupMattermostIntegration retrieves the Mattermost integration for a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-notifications

func (*IntegrationsService) GetGroupMattermostSettings added in v1.19.0 

func (s *IntegrationsService) GetGroupMattermostSettings(gid any, options ...RequestOptionFunc) (*MattermostIntegration, *Response, error)

func (*IntegrationsService) GetGroupMattermostSlashCommandsIntegration added in v1.17.0 

func (s *IntegrationsService) GetGroupMattermostSlashCommandsIntegration(gid any, options ...RequestOptionFunc) (*GroupMattermostSlashCommandsIntegration, *Response, error)

GetGroupMattermostSlashCommandsIntegration retrieves the Mattermost slash commands integration for a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands

func (*IntegrationsService) GetGroupMicrosoftTeamsNotifications added in v0.135.0 

func (s *IntegrationsService) GetGroupMicrosoftTeamsNotifications(gid any, options ...RequestOptionFunc) (*Integration, *Response, error)

func (*IntegrationsService) GetGroupSlackSettings added in v1.26.0 

func (s *IntegrationsService) GetGroupSlackSettings(gid any, options ...RequestOptionFunc) (*SlackIntegration, *Response, error)

func (*IntegrationsService) GetGroupTelegramSettings added in v1.19.0 

func (s *IntegrationsService) GetGroupTelegramSettings(gid any, options ...RequestOptionFunc) (*TelegramIntegration, *Response, error)

func (*IntegrationsService) GetGroupWebexTeamsSettings added in v1.25.0 

func (s *IntegrationsService) GetGroupWebexTeamsSettings(gid any, options ...RequestOptionFunc) (*WebexTeamsIntegration, *Response, error)

func (*IntegrationsService) GetProjectGoogleChatSettings added in v1.36.0 

func (s *IntegrationsService) GetProjectGoogleChatSettings(pid any, options ...RequestOptionFunc) (*GoogleChatIntegration, *Response, error)

func (*IntegrationsService) ListActiveGroupIntegrations added in v0.135.0 

func (s *IntegrationsService) ListActiveGroupIntegrations(gid any, opt *ListActiveIntegrationsOptions, options ...RequestOptionFunc) ([]*Integration, *Response, error)

func (*IntegrationsService) SetGroupMattermostIntegration added in v1.17.0 

func (s *IntegrationsService) SetGroupMattermostIntegration(gid any, opt *GroupMattermostIntegrationOptions, options ...RequestOptionFunc) (*GroupMattermostIntegration, *Response, error)

SetGroupMattermostIntegration creates or updates the Mattermost integration for a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-notifications

func (*IntegrationsService) SetGroupMattermostSlashCommandsIntegration added in v1.17.0 

func (s *IntegrationsService) SetGroupMattermostSlashCommandsIntegration(gid any, opt *GroupMattermostSlashCommandsIntegrationOptions, options ...RequestOptionFunc) (*GroupMattermostSlashCommandsIntegration, *Response, error)

SetGroupMattermostSlashCommandsIntegration creates or updates the Mattermost slash commands integration for a group.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands

func (*IntegrationsService) SetGroupMicrosoftTeamsNotifications added in v0.135.0 

func (s *IntegrationsService) SetGroupMicrosoftTeamsNotifications(gid any, opt *SetMicrosoftTeamsNotificationsOptions, options ...RequestOptionFunc) (*Integration, *Response, error)

func (*IntegrationsService) SetGroupSlackSettings added in v1.26.0 

func (s *IntegrationsService) SetGroupSlackSettings(gid any, opt *SetGroupSlackOptions, options ...RequestOptionFunc) (*SlackIntegration, *Response, error)

func (*IntegrationsService) SetGroupWebexTeamsSettings added in v1.25.0 

func (s *IntegrationsService) SetGroupWebexTeamsSettings(gid any, opt *SetGroupWebexTeamsOptions, options ...RequestOptionFunc) (*WebexTeamsIntegration, *Response, error)

func (*IntegrationsService) SetProjectGoogleChatSettings added in v1.36.0 

func (s *IntegrationsService) SetProjectGoogleChatSettings(pid any, opt *SetProjectGoogleChatOptions, options ...RequestOptionFunc) (*GoogleChatIntegration, *Response, error)

func (*IntegrationsService) SetUpGroupHarbor added in v0.137.0 

func (s *IntegrationsService) SetUpGroupHarbor(gid any, opt *SetUpHarborOptions, options ...RequestOptionFunc) (*Integration, *Response, error)

func (*IntegrationsService) SetUpGroupJira added in v0.159.0 

func (s *IntegrationsService) SetUpGroupJira(gid any, opt *SetUpJiraOptions, options ...RequestOptionFunc) (*Integration, *Response, error)

type IntegrationsServiceInterface added in v0.135.0 

type IntegrationsServiceInterface interface {
	// ListActiveGroupIntegrations gets a list of all active group integrations.
	// The vulnerability_events field is only available for GitLab Enterprise Edition.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#list-all-active-integrations
	ListActiveGroupIntegrations(gid any, opt *ListActiveIntegrationsOptions, options ...RequestOptionFunc) ([]*Integration, *Response, error)

	// SetUpGroupHarbor sets up the Harbor integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#set-up-harbor
	SetUpGroupHarbor(gid any, opt *SetUpHarborOptions, options ...RequestOptionFunc) (*Integration, *Response, error)

	// DisableGroupHarbor disables the Harbor integration for a group.
	// Integration settings are reset.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#disable-harbor
	DisableGroupHarbor(gid any, options ...RequestOptionFunc) (*Response, error)

	// GetGroupHarborSettings gets the Harbor integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#get-harbor-settings
	GetGroupHarborSettings(gid any, options ...RequestOptionFunc) (*Integration, *Response, error)

	// SetGroupMicrosoftTeamsNotifications sets up Microsoft Teams notifications for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#set-up-microsoft-teams-notifications
	SetGroupMicrosoftTeamsNotifications(gid any, opt *SetMicrosoftTeamsNotificationsOptions, options ...RequestOptionFunc) (*Integration, *Response, error)

	// DisableGroupMicrosoftTeamsNotifications disables Microsoft Teams notifications
	// for a group. Integration settings are reset.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#disable-microsoft-teams-notifications
	DisableGroupMicrosoftTeamsNotifications(gid any, options ...RequestOptionFunc) (*Response, error)

	// GetGroupMicrosoftTeamsNotifications gets the Microsoft Teams notifications for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#get-microsoft-teams-notifications-settings
	GetGroupMicrosoftTeamsNotifications(gid any, options ...RequestOptionFunc) (*Integration, *Response, error)

	// SetUpGroupJira sets up the Jira integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#set-up-jira
	SetUpGroupJira(gid any, opt *SetUpJiraOptions, options ...RequestOptionFunc) (*Integration, *Response, error)

	// DisableGroupJira disables the Jira integration for a group.
	// Integration settings are reset.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#disable-jira
	DisableGroupJira(gid any, options ...RequestOptionFunc) (*Response, error)

	// GetGroupJiraSettings gets the Jira integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#get-jira-settings
	GetGroupJiraSettings(gid any, options ...RequestOptionFunc) (*Integration, *Response, error)

	// GetGroupSlackSettings gets the Slack integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#get-slack-settings
	GetGroupSlackSettings(gid any, options ...RequestOptionFunc) (*SlackIntegration, *Response, error)

	// SetGroupSlackSettings sets up the Slack integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#set-up-slack
	SetGroupSlackSettings(gid any, opt *SetGroupSlackOptions, options ...RequestOptionFunc) (*SlackIntegration, *Response, error)

	// DisableGroupSlack disables the Slack integration for a group.
	// Integration settings are reset.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#disable-slack
	DisableGroupSlack(gid any, options ...RequestOptionFunc) (*Response, error)

	// GetGroupDiscordSettings gets the Discord integration settings for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#discord
	GetGroupDiscordSettings(gid any, options ...RequestOptionFunc) (*DiscordIntegration, *Response, error)

	// GetGroupTelegramSettings gets the Telegram integration settings for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#telegram
	GetGroupTelegramSettings(gid any, options ...RequestOptionFunc) (*TelegramIntegration, *Response, error)

	// GetGroupMattermostSettings gets the Mattermost integration settings for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
	GetGroupMattermostSettings(gid any, options ...RequestOptionFunc) (*MattermostIntegration, *Response, error)

	// GetGroupMatrixSettings gets the Matrix integration settings for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#matrix-notifications
	GetGroupMatrixSettings(gid any, options ...RequestOptionFunc) (*MatrixIntegration, *Response, error)

	// GetGroupGoogleChatSettings gets the Google Chat integration settings for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#google-chat
	GetGroupGoogleChatSettings(gid any, options ...RequestOptionFunc) (*GoogleChatIntegration, *Response, error)

	// SetProjectGoogleChatSettings sets up the Google Chat integration for a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/integrations.html#set-up-google-chat
	SetProjectGoogleChatSettings(pid any, opt *SetProjectGoogleChatOptions, options ...RequestOptionFunc) (*GoogleChatIntegration, *Response, error)

	// DisableProjectGoogleChat disables the Google Chat integration for a project.
	// Integration settings are reset.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/integrations.html#disable-google-chat
	DisableProjectGoogleChat(pid any, options ...RequestOptionFunc) (*Response, error)

	// GetProjectGoogleChatSettings gets the Google Chat integration settings for a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/integrations.html#get-google-chat-settings
	GetProjectGoogleChatSettings(pid any, options ...RequestOptionFunc) (*GoogleChatIntegration, *Response, error)

	// GetGroupMattermostIntegration retrieves the Mattermost integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
	GetGroupMattermostIntegration(gid any, options ...RequestOptionFunc) (*GroupMattermostIntegration, *Response, error)

	// SetGroupMattermostIntegration creates or updates the Mattermost integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
	SetGroupMattermostIntegration(gid any, opt *GroupMattermostIntegrationOptions, options ...RequestOptionFunc) (*GroupMattermostIntegration, *Response, error)

	// DeleteGroupMattermostIntegration removes the Mattermost integration from a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
	DeleteGroupMattermostIntegration(gid any, options ...RequestOptionFunc) (*Response, error)

	// GetGroupMattermostSlashCommandsIntegration retrieves the Mattermost slash commands integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
	GetGroupMattermostSlashCommandsIntegration(gid any, options ...RequestOptionFunc) (*GroupMattermostSlashCommandsIntegration, *Response, error)

	// SetGroupMattermostSlashCommandsIntegration creates or updates the Mattermost slash commands integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
	SetGroupMattermostSlashCommandsIntegration(gid any, opt *GroupMattermostSlashCommandsIntegrationOptions, options ...RequestOptionFunc) (*GroupMattermostSlashCommandsIntegration, *Response, error)

	// DeleteGroupMattermostSlashCommandsIntegration removes the Mattermost slash commands integration from a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
	DeleteGroupMattermostSlashCommandsIntegration(gid any, options ...RequestOptionFunc) (*Response, error)

	// GetGroupWebexTeamsSettings gets the Webex Teams integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#get-webex-teams-settings
	GetGroupWebexTeamsSettings(gid any, options ...RequestOptionFunc) (*WebexTeamsIntegration, *Response, error)

	// SetGroupWebexTeamsSettings sets up the Webex Teams integration for a group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#set-up-webex-teams
	SetGroupWebexTeamsSettings(gid any, opt *SetGroupWebexTeamsOptions, options ...RequestOptionFunc) (*WebexTeamsIntegration, *Response, error)

	// DisableGroupWebexTeams disables the Webex Teams integration for a group.
	// Integration settings are reset.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/group_integrations/#disable-webex-teams
	DisableGroupWebexTeams(gid any, options ...RequestOptionFunc) (*Response, error)
}

type Interceptor added in v0.144.0 

type Interceptor func(next http.RoundTripper) http.RoundTripper

Interceptor is used to build a *http.Client request pipeline,

It receives the next RoundTripper in the chain and returns a new one that will be used for the request.

This next RoundTripper might or might not be the actual transporter, which actually does the request call, but it is safe to assume that calling the next will result in the expected HTTP call.

Example: 

// Simple logger interceptor.
logger := func(next http.RoundTripper) http.RoundTripper {
    return roundtripperFunc(func(req *http.Request) (*http.Response, error) {
        fmt.Printf("Request: %s %s\n", req.Method, req.URL)
        resp, err := next.RoundTrip(req)
        if err == nil {
            fmt.Printf("Response status: %d\n", resp.StatusCode)
        }
        return resp, err
    })
}

The Interceptor type lets you add such middlewares to a client by chaining them.

type InvitesOptions added in v0.116.0 

type InvitesOptions struct {
	ID          any               `url:"id,omitempty" json:"id,omitempty"`
	Email       *string           `url:"email,omitempty" json:"email,omitempty"`
	UserID      any               `url:"user_id,omitempty" json:"user_id,omitempty"`
	AccessLevel *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"`
	ExpiresAt   *ISOTime          `url:"expires_at,omitempty" json:"expires_at,omitempty"`
}

InvitesOptions represents the available GroupInvites() and ProjectInvites() options.

GitLab API docs: https://docs.gitlab.com/api/invitations/#add-a-member-to-a-group-or-project

type InvitesResult added in v0.116.0 

type InvitesResult struct {
	Status  string            `json:"status"`
	Message map[string]string `json:"message,omitempty"`
}

InvitesResult represents an invitations result.

GitLab API docs: https://docs.gitlab.com/api/invitations/#add-a-member-to-a-group-or-project

type InvitesService added in v0.116.0 

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

InvitesService handles communication with the invitation related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/invitations/

func (*InvitesService) GroupInvites added in v0.116.0 

func (s *InvitesService) GroupInvites(gid any, opt *InvitesOptions, options ...RequestOptionFunc) (*InvitesResult, *Response, error)

GroupInvites invites new users by email to join a group.

GitLab API docs: https://docs.gitlab.com/api/invitations/#add-a-member-to-a-group-or-project

func (*InvitesService) ListPendingGroupInvitations added in v0.116.0 

func (s *InvitesService) ListPendingGroupInvitations(gid any, opt *ListPendingInvitationsOptions, options ...RequestOptionFunc) ([]*PendingInvite, *Response, error)

ListPendingGroupInvitations gets a list of invited group members.

GitLab API docs: https://docs.gitlab.com/api/invitations/#list-all-invitations-pending-for-a-group-or-project

func (*InvitesService) ListPendingProjectInvitations added in v0.116.0 

func (s *InvitesService) ListPendingProjectInvitations(pid any, opt *ListPendingInvitationsOptions, options ...RequestOptionFunc) ([]*PendingInvite, *Response, error)

ListPendingProjectInvitations gets a list of invited project members.

GitLab API docs: https://docs.gitlab.com/api/invitations/#list-all-invitations-pending-for-a-group-or-project

func (*InvitesService) ProjectInvites added in v0.116.0 

func (s *InvitesService) ProjectInvites(pid any, opt *InvitesOptions, options ...RequestOptionFunc) (*InvitesResult, *Response, error)

ProjectInvites invites new users by email to join a project.

GitLab API docs: https://docs.gitlab.com/api/invitations/#add-a-member-to-a-group-or-project

type InvitesServiceInterface added in v0.126.0 

type InvitesServiceInterface interface {
	ListPendingGroupInvitations(gid any, opt *ListPendingInvitationsOptions, options ...RequestOptionFunc) ([]*PendingInvite, *Response, error)
	ListPendingProjectInvitations(pid any, opt *ListPendingInvitationsOptions, options ...RequestOptionFunc) ([]*PendingInvite, *Response, error)
	GroupInvites(gid any, opt *InvitesOptions, options ...RequestOptionFunc) (*InvitesResult, *Response, error)
	ProjectInvites(pid any, opt *InvitesOptions, options ...RequestOptionFunc) (*InvitesResult, *Response, error)
}

type Issue 

type Issue struct {
	ID                   int64                  `json:"id"`
	IID                  int64                  `json:"iid"`
	ExternalID           string                 `json:"external_id"`
	State                string                 `json:"state"`
	Description          string                 `json:"description"`
	HealthStatus         string                 `json:"health_status"`
	Author               *IssueAuthor           `json:"author"`
	Milestone            *Milestone             `json:"milestone"`
	ProjectID            int64                  `json:"project_id"`
	Assignees            []*IssueAssignee       `json:"assignees"`
	UpdatedAt            *time.Time             `json:"updated_at"`
	ClosedAt             *time.Time             `json:"closed_at"`
	ClosedBy             *IssueCloser           `json:"closed_by"`
	Title                string                 `json:"title"`
	CreatedAt            *time.Time             `json:"created_at"`
	MovedToID            int64                  `json:"moved_to_id"`
	Labels               Labels                 `json:"labels"`
	LabelDetails         []*LabelDetails        `json:"label_details"`
	Upvotes              int64                  `json:"upvotes"`
	Downvotes            int64                  `json:"downvotes"`
	DueDate              *ISOTime               `json:"due_date"`
	WebURL               string                 `json:"web_url"`
	References           *IssueReferences       `json:"references"`
	TimeStats            *TimeStats             `json:"time_stats"`
	Confidential         bool                   `json:"confidential"`
	Weight               int64                  `json:"weight"`
	DiscussionLocked     bool                   `json:"discussion_locked"`
	IssueType            *string                `json:"issue_type,omitempty"`
	Subscribed           bool                   `json:"subscribed"`
	UserNotesCount       int64                  `json:"user_notes_count"`
	Links                *IssueLinks            `json:"_links"`
	IssueLinkID          int64                  `json:"issue_link_id"`
	MergeRequestCount    int64                  `json:"merge_requests_count"`
	EpicIssueID          int64                  `json:"epic_issue_id"`
	Epic                 *Epic                  `json:"epic"`
	Iteration            *GroupIteration        `json:"iteration"`
	TaskCompletionStatus *TasksCompletionStatus `json:"task_completion_status"`
	ServiceDeskReplyTo   string                 `json:"service_desk_reply_to"`

	// Deprecated: use Assignees instead
	Assignee *IssueAssignee `json:"assignee"`
}

Issue represents a GitLab issue.

GitLab API docs: https://docs.gitlab.com/api/issues/

func (Issue) String 

func (i Issue) String() string

func (*Issue) UnmarshalJSON added in v0.116.0 

func (i *Issue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type IssueAssignee added in v0.116.0 

type IssueAssignee struct {
	ID        int64  `json:"id"`
	State     string `json:"state"`
	WebURL    string `json:"web_url"`
	Name      string `json:"name"`
	AvatarURL string `json:"avatar_url"`
	Username  string `json:"username"`
}

IssueAssignee represents a assignee of the issue.

type IssueAuthor added in v0.116.0 

type IssueAuthor struct {
	ID        int64  `json:"id"`
	State     string `json:"state"`
	WebURL    string `json:"web_url"`
	Name      string `json:"name"`
	AvatarURL string `json:"avatar_url"`
	Username  string `json:"username"`
}

IssueAuthor represents a author of the issue.

type IssueBoard added in v0.8.0 

type IssueBoard struct {
	ID              int64           `json:"id"`
	Name            string          `json:"name"`
	Project         *Project        `json:"project"`
	Milestone       *Milestone      `json:"milestone"`
	Assignee        *BasicUser      `json:"assignee"`
	Lists           []*BoardList    `json:"lists"`
	Weight          int64           `json:"weight"`
	Labels          []*LabelDetails `json:"labels"`
	HideBacklogList bool            `json:"hide_backlog_list"`
	HideClosedList  bool            `json:"hide_closed_list"`
}

IssueBoard represents a GitLab issue board.

GitLab API docs: https://docs.gitlab.com/api/boards/

func (IssueBoard) String added in v0.8.0 

func (b IssueBoard) String() string

type IssueBoardsService added in v0.8.0 

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

IssueBoardsService handles communication with the issue board related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/boards/

func (*IssueBoardsService) CreateIssueBoard added in v0.116.0 

func (s *IssueBoardsService) CreateIssueBoard(pid any, opt *CreateIssueBoardOptions, options ...RequestOptionFunc) (*IssueBoard, *Response, error)

func (*IssueBoardsService) CreateIssueBoardList added in v0.8.0 

func (s *IssueBoardsService) CreateIssueBoardList(pid any, board int64, opt *CreateIssueBoardListOptions, options ...RequestOptionFunc) (*BoardList, *Response, error)

func (*IssueBoardsService) DeleteIssueBoard added in v0.116.0 

func (s *IssueBoardsService) DeleteIssueBoard(pid any, board int64, options ...RequestOptionFunc) (*Response, error)

func (*IssueBoardsService) DeleteIssueBoardList added in v0.8.0 

func (s *IssueBoardsService) DeleteIssueBoardList(pid any, board, list int64, options ...RequestOptionFunc) (*Response, error)

func (*IssueBoardsService) GetIssueBoard added in v0.8.0 

func (s *IssueBoardsService) GetIssueBoard(pid any, board int64, options ...RequestOptionFunc) (*IssueBoard, *Response, error)

func (*IssueBoardsService) GetIssueBoardList added in v0.8.0 

func (s *IssueBoardsService) GetIssueBoardList(pid any, board, list int64, options ...RequestOptionFunc) (*BoardList, *Response, error)

func (*IssueBoardsService) GetIssueBoardLists added in v0.8.0 

func (s *IssueBoardsService) GetIssueBoardLists(pid any, board int64, opt *GetIssueBoardListsOptions, options ...RequestOptionFunc) ([]*BoardList, *Response, error)

func (*IssueBoardsService) ListIssueBoards added in v0.8.0 

func (s *IssueBoardsService) ListIssueBoards(pid any, opt *ListIssueBoardsOptions, options ...RequestOptionFunc) ([]*IssueBoard, *Response, error)

func (*IssueBoardsService) UpdateIssueBoard added in v0.116.0 

func (s *IssueBoardsService) UpdateIssueBoard(pid any, board int64, opt *UpdateIssueBoardOptions, options ...RequestOptionFunc) (*IssueBoard, *Response, error)

func (*IssueBoardsService) UpdateIssueBoardList added in v0.8.0 

func (s *IssueBoardsService) UpdateIssueBoardList(pid any, board, list int64, opt *UpdateIssueBoardListOptions, options ...RequestOptionFunc) (*BoardList, *Response, error)

type IssueBoardsServiceInterface added in v0.126.0 

type IssueBoardsServiceInterface interface {
	// CreateIssueBoard creates a new issue board.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#create-an-issue-board
	// CreateIssueBoard creates a new issue board.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#create-an-issue-board
	CreateIssueBoard(pid any, opt *CreateIssueBoardOptions, options ...RequestOptionFunc) (*IssueBoard, *Response, error)

	// UpdateIssueBoard update an issue board.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#update-an-issue-board
	UpdateIssueBoard(pid any, board int64, opt *UpdateIssueBoardOptions, options ...RequestOptionFunc) (*IssueBoard, *Response, error)

	// DeleteIssueBoard deletes an issue board.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#delete-an-issue-board
	DeleteIssueBoard(pid any, board int64, options ...RequestOptionFunc) (*Response, error)

	// ListIssueBoards gets a list of all issue boards in a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#list-project-issue-boards
	ListIssueBoards(pid any, opt *ListIssueBoardsOptions, options ...RequestOptionFunc) ([]*IssueBoard, *Response, error)

	// GetIssueBoard gets a single issue board of a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#show-a-single-issue-board
	GetIssueBoard(pid any, board int64, options ...RequestOptionFunc) (*IssueBoard, *Response, error)

	// GetIssueBoardLists gets a list of the issue board's lists. Does not include
	// backlog and closed lists.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#list-board-lists-in-a-project-issue-board
	GetIssueBoardLists(pid any, board int64, opt *GetIssueBoardListsOptions, options ...RequestOptionFunc) ([]*BoardList, *Response, error)

	// GetIssueBoardList gets a single issue board list.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#show-a-single-board-list
	GetIssueBoardList(pid any, board, list int64, options ...RequestOptionFunc) (*BoardList, *Response, error)

	// CreateIssueBoardList creates a new issue board list.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#create-a-board-list
	CreateIssueBoardList(pid any, board int64, opt *CreateIssueBoardListOptions, options ...RequestOptionFunc) (*BoardList, *Response, error)

	// UpdateIssueBoardList updates the position of an existing issue board list.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#reorder-a-list-in-a-board
	UpdateIssueBoardList(pid any, board, list int64, opt *UpdateIssueBoardListOptions, options ...RequestOptionFunc) (*BoardList, *Response, error)

	// DeleteIssueBoardList soft deletes an issue board list. Only for admins and
	// project owners.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/boards/#delete-a-board-list-from-a-board
	DeleteIssueBoardList(pid any, board, list int64, options ...RequestOptionFunc) (*Response, error)
}

type IssueCloser added in v0.116.0 

type IssueCloser struct {
	ID        int64  `json:"id"`
	State     string `json:"state"`
	WebURL    string `json:"web_url"`
	Name      string `json:"name"`
	AvatarURL string `json:"avatar_url"`
	Username  string `json:"username"`
}

IssueCloser represents a closer of the issue.

type IssueCommentEvent added in v0.3.1 

type IssueCommentEvent struct {
	ObjectKind       string                            `json:"object_kind"`
	EventType        string                            `json:"event_type"`
	User             *User                             `json:"user"`
	ProjectID        int64                             `json:"project_id"`
	Project          IssueCommentEventProject          `json:"project"`
	Repository       *Repository                       `json:"repository"`
	ObjectAttributes IssueCommentEventObjectAttributes `json:"object_attributes"`
	Issue            IssueCommentEventIssue            `json:"issue"`
}

IssueCommentEvent represents a comment on an issue event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#comment-on-an-issue

type IssueCommentEventIssue added in v1.0.0 

type IssueCommentEventIssue struct {
	ID                  int64         `json:"id"`
	IID                 int64         `json:"iid"`
	ProjectID           int64         `json:"project_id"`
	MilestoneID         int64         `json:"milestone_id"`
	AuthorID            int64         `json:"author_id"`
	Position            int64         `json:"position"`
	BranchName          string        `json:"branch_name"`
	Description         string        `json:"description"`
	State               string        `json:"state"`
	Title               string        `json:"title"`
	Labels              []*EventLabel `json:"labels"`
	LastEditedAt        string        `json:"last_edit_at"`
	LastEditedByID      int64         `json:"last_edited_by_id"`
	UpdatedAt           string        `json:"updated_at"`
	UpdatedByID         int64         `json:"updated_by_id"`
	CreatedAt           string        `json:"created_at"`
	ClosedAt            string        `json:"closed_at"`
	DueDate             *ISOTime      `json:"due_date"`
	URL                 string        `json:"url"`
	TimeEstimate        int64         `json:"time_estimate"`
	Confidential        bool          `json:"confidential"`
	TotalTimeSpent      int64         `json:"total_time_spent"`
	HumanTotalTimeSpent string        `json:"human_total_time_spent"`
	HumanTimeEstimate   string        `json:"human_time_estimate"`
	AssigneeIDs         []int64       `json:"assignee_ids"`
	AssigneeID          int64         `json:"assignee_id"`
}

type IssueCommentEventObjectAttributes added in v1.0.0 

type IssueCommentEventObjectAttributes struct {
	ID           int64              `json:"id"`
	Note         string             `json:"note"`
	NoteableType string             `json:"noteable_type"`
	AuthorID     int64              `json:"author_id"`
	CreatedAt    string             `json:"created_at"`
	UpdatedAt    string             `json:"updated_at"`
	ProjectID    int64              `json:"project_id"`
	Attachment   string             `json:"attachment"`
	LineCode     string             `json:"line_code"`
	CommitID     string             `json:"commit_id"`
	DiscussionID string             `json:"discussion_id"`
	NoteableID   int64              `json:"noteable_id"`
	System       bool               `json:"system"`
	StDiff       []*Diff            `json:"st_diff"`
	Description  string             `json:"description"`
	Action       CommentEventAction `json:"action"`
	URL          string             `json:"url"`
}

type IssueCommentEventProject added in v1.0.0 

type IssueCommentEventProject struct {
	Name              string          `json:"name"`
	Description       string          `json:"description"`
	AvatarURL         string          `json:"avatar_url"`
	GitSSHURL         string          `json:"git_ssh_url"`
	GitHTTPURL        string          `json:"git_http_url"`
	Namespace         string          `json:"namespace"`
	PathWithNamespace string          `json:"path_with_namespace"`
	DefaultBranch     string          `json:"default_branch"`
	Homepage          string          `json:"homepage"`
	URL               string          `json:"url"`
	SSHURL            string          `json:"ssh_url"`
	HTTPURL           string          `json:"http_url"`
	WebURL            string          `json:"web_url"`
	Visibility        VisibilityValue `json:"visibility"`
}

type IssueEvent added in v0.3.1 

type IssueEvent struct {
	ObjectKind       string                     `json:"object_kind"`
	EventType        string                     `json:"event_type"`
	User             *EventUser                 `json:"user"`
	Project          IssueEventProject          `json:"project"`
	Repository       *Repository                `json:"repository"`
	ObjectAttributes IssueEventObjectAttributes `json:"object_attributes"`
	Assignee         *EventUser                 `json:"assignee"`
	Assignees        *[]EventUser               `json:"assignees"`
	Labels           []*EventLabel              `json:"labels"`
	Changes          IssueEventChanges          `json:"changes"`
}

IssueEvent represents a issue event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#work-item-events

type IssueEventChanges added in v1.0.0 

type IssueEventChanges struct {
	Assignees      EventChangesAssignees           `json:"assignees"`
	Description    EventChangesDescription         `json:"description"`
	Labels         EventChangesLabels              `json:"labels"`
	Title          EventChangesTitle               `json:"title"`
	ClosedAt       IssueEventChangesClosedAt       `json:"closed_at"`
	StateID        EventChangesStateID             `json:"state_id"`
	UpdatedAt      EventChangesUpdatedAt           `json:"updated_at"`
	UpdatedByID    EventChangesUpdatedByID         `json:"updated_by_id"`
	TotalTimeSpent IssueEventChangesTotalTimeSpent `json:"total_time_spent"`
}

type IssueEventChangesClosedAt added in v1.0.0 

type IssueEventChangesClosedAt struct {
	Previous string `json:"previous"`
	Current  string `json:"current"`
}

type IssueEventChangesTotalTimeSpent added in v1.0.0 

type IssueEventChangesTotalTimeSpent struct {
	Previous int64 `json:"previous"`
	Current  int64 `json:"current"`
}

type IssueEventObjectAttributes added in v1.0.0 

type IssueEventObjectAttributes struct {
	ID                  int64                                      `json:"id"`
	Title               string                                     `json:"title"`
	AssigneeIDs         []int64                                    `json:"assignee_ids"`
	AssigneeID          int64                                      `json:"assignee_id"`
	AuthorID            int64                                      `json:"author_id"`
	ProjectID           int64                                      `json:"project_id"`
	CreatedAt           string                                     `json:"created_at"` // Should be *time.Time (see Gitlab issue #21468)
	UpdatedAt           string                                     `json:"updated_at"` // Should be *time.Time (see Gitlab issue #21468)
	UpdatedByID         int64                                      `json:"updated_by_id"`
	LastEditedAt        string                                     `json:"last_edited_at"`
	LastEditedByID      int64                                      `json:"last_edited_by_id"`
	RelativePosition    int64                                      `json:"relative_position"`
	BranchName          string                                     `json:"branch_name"`
	Description         string                                     `json:"description"`
	MilestoneID         int64                                      `json:"milestone_id"`
	StateID             StateID                                    `json:"state_id"`
	Confidential        bool                                       `json:"confidential"`
	DiscussionLocked    bool                                       `json:"discussion_locked"`
	DueDate             *ISOTime                                   `json:"due_date"`
	MovedToID           int64                                      `json:"moved_to_id"`
	DuplicatedToID      int64                                      `json:"duplicated_to_id"`
	TimeEstimate        int64                                      `json:"time_estimate"`
	TotalTimeSpent      int64                                      `json:"total_time_spent"`
	TimeChange          int64                                      `json:"time_change"`
	HumanTotalTimeSpent string                                     `json:"human_total_time_spent"`
	HumanTimeEstimate   string                                     `json:"human_time_estimate"`
	HumanTimeChange     string                                     `json:"human_time_change"`
	Weight              int64                                      `json:"weight"`
	IID                 int64                                      `json:"iid"`
	URL                 string                                     `json:"url"`
	State               string                                     `json:"state"`
	Action              string                                     `json:"action"`
	Severity            string                                     `json:"severity"`
	EscalationStatus    string                                     `json:"escalation_status"`
	EscalationPolicy    IssueEventObjectAttributesEscalationPolicy `json:"escalation_policy"`
	Labels              []*EventLabel                              `json:"labels"`
}

type IssueEventObjectAttributesEscalationPolicy added in v1.0.0 

type IssueEventObjectAttributesEscalationPolicy struct {
	ID   int64  `json:"id"`
	Name string `json:"name"`
}

type IssueEventProject added in v1.0.0 

type IssueEventProject struct {
	ID                int64           `json:"id"`
	Name              string          `json:"name"`
	Description       string          `json:"description"`
	AvatarURL         string          `json:"avatar_url"`
	GitSSHURL         string          `json:"git_ssh_url"`
	GitHTTPURL        string          `json:"git_http_url"`
	Namespace         string          `json:"namespace"`
	PathWithNamespace string          `json:"path_with_namespace"`
	DefaultBranch     string          `json:"default_branch"`
	Homepage          string          `json:"homepage"`
	URL               string          `json:"url"`
	SSHURL            string          `json:"ssh_url"`
	HTTPURL           string          `json:"http_url"`
	WebURL            string          `json:"web_url"`
	Visibility        VisibilityValue `json:"visibility"`
}
type IssueLink struct {
	ID          int64  `json:"id"`
	SourceIssue *Issue `json:"source_issue"`
	TargetIssue *Issue `json:"target_issue"`
	LinkType    string `json:"link_type"`
}

IssueLink represents a two-way relation between two issues.

GitLab API docs: https://docs.gitlab.com/api/issue_links/ 

type IssueLinks struct {
	Self       string `json:"self"`
	Notes      string `json:"notes"`
	AwardEmoji string `json:"award_emoji"`
	Project    string `json:"project"`
}

IssueLinks represents links of the issue.

type IssueLinksService added in v0.8.0 

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

IssueLinksService handles communication with the issue relations related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/issue_links/ 

func (s *IssueLinksService) CreateIssueLink(pid any, issue int64, opt *CreateIssueLinkOptions, options ...RequestOptionFunc) (*IssueLink, *Response, error)

CreateIssueLink creates a two-way relation between two issues. User must be allowed to update both issues in order to succeed.

GitLab API docs: https://docs.gitlab.com/api/issue_links/#create-an-issue-link 

func (s *IssueLinksService) DeleteIssueLink(pid any, issue, issueLink int64, options ...RequestOptionFunc) (*IssueLink, *Response, error)

DeleteIssueLink deletes an issue link, thus removes the two-way relationship.

GitLab API docs: https://docs.gitlab.com/api/issue_links/#delete-an-issue-link 

func (s *IssueLinksService) GetIssueLink(pid any, issue, issueLink int64, options ...RequestOptionFunc) (*IssueLink, *Response, error)

GetIssueLink gets a specific issue link.

GitLab API docs: https://docs.gitlab.com/api/issue_links/#get-an-issue-link

func (*IssueLinksService) ListIssueRelations added in v0.8.0 

func (s *IssueLinksService) ListIssueRelations(pid any, issue int64, options ...RequestOptionFunc) ([]*IssueRelation, *Response, error)

ListIssueRelations gets a list of related issues of a given issue, sorted by the relationship creation datetime (ascending).

Issues will be filtered according to the user authorizations.

GitLab API docs: https://docs.gitlab.com/api/issue_links/#list-issue-relations

type IssueLinksServiceInterface added in v0.126.0 

type IssueLinksServiceInterface interface {
	ListIssueRelations(pid any, issue int64, options ...RequestOptionFunc) ([]*IssueRelation, *Response, error)
	GetIssueLink(pid any, issue, issueLink int64, options ...RequestOptionFunc) (*IssueLink, *Response, error)
	CreateIssueLink(pid any, issue int64, opt *CreateIssueLinkOptions, options ...RequestOptionFunc) (*IssueLink, *Response, error)
	DeleteIssueLink(pid any, issue, issueLink int64, options ...RequestOptionFunc) (*IssueLink, *Response, error)
}

type IssueReferences added in v0.116.0 

type IssueReferences struct {
	Short    string `json:"short"`
	Relative string `json:"relative"`
	Full     string `json:"full"`
}

IssueReferences represents references of the issue.

type IssueRelation added in v0.116.0 

type IssueRelation struct {
	ID             int64            `json:"id"`
	IID            int64            `json:"iid"`
	State          string           `json:"state"`
	Description    string           `json:"description"`
	Confidential   bool             `json:"confidential"`
	Author         *IssueAuthor     `json:"author"`
	Milestone      *Milestone       `json:"milestone"`
	ProjectID      int64            `json:"project_id"`
	Assignees      []*IssueAssignee `json:"assignees"`
	Assignee       *IssueAssignee   `json:"assignee"`
	UpdatedAt      *time.Time       `json:"updated_at"`
	Title          string           `json:"title"`
	CreatedAt      *time.Time       `json:"created_at"`
	Labels         Labels           `json:"labels"`
	DueDate        *ISOTime         `json:"due_date"`
	WebURL         string           `json:"web_url"`
	References     *IssueReferences `json:"references"`
	Weight         int64            `json:"weight"`
	UserNotesCount int64            `json:"user_notes_count"`
	IssueLinkID    int64            `json:"issue_link_id"`
	LinkType       string           `json:"link_type"`
	LinkCreatedAt  *time.Time       `json:"link_created_at"`
	LinkUpdatedAt  *time.Time       `json:"link_updated_at"`
}

IssueRelation gets a relation between two issues.

GitLab API docs: https://docs.gitlab.com/api/issue_links/#list-issue-relations

type IssuesCount added in v0.128.0 

type IssuesCount struct {
	IssuesCount int64 `url:"issues_count" json:"issues_count"`
}

IssuesCount represents the total count of recently created issues in a group.

GitLab API docs: https://docs.gitlab.com/api/group_activity_analytics/#get-count-of-recently-created-issues-for-group

type IssuesService 

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

IssuesService handles communication with the issue related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/issues/

func (*IssuesService) AddSpentTime added in v0.6.0 

func (s *IssuesService) AddSpentTime(pid any, issue int64, opt *AddSpentTimeOptions, options ...RequestOptionFunc) (*TimeStats, *Response, error)

AddSpentTime adds spent time for a single project issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#add-spent-time-for-an-issue

func (*IssuesService) CreateIssue 

func (s *IssuesService) CreateIssue(pid any, opt *CreateIssueOptions, options ...RequestOptionFunc) (*Issue, *Response, error)

CreateIssue creates a new project issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#new-issue

func (*IssuesService) CreateTodo added in v0.116.0 

func (s *IssuesService) CreateTodo(pid any, issue int64, options ...RequestOptionFunc) (*Todo, *Response, error)

CreateTodo creates a todo for the current user for an issue. If there already exists a todo for the user on that issue, status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/issues/#create-a-to-do-item

func (*IssuesService) DeleteIssue 

func (s *IssuesService) DeleteIssue(pid any, issue int64, options ...RequestOptionFunc) (*Response, error)

DeleteIssue deletes a single project issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#delete-an-issue

func (*IssuesService) GetIssue 

func (s *IssuesService) GetIssue(pid any, issue int64, options ...RequestOptionFunc) (*Issue, *Response, error)

GetIssue gets a single project issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#single-project-issue

func (*IssuesService) GetIssueByID added in v0.116.0 

func (s *IssuesService) GetIssueByID(issue int64, options ...RequestOptionFunc) (*Issue, *Response, error)

GetIssueByID gets a single issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#single-issue

func (*IssuesService) GetParticipants added in v0.116.0 

func (s *IssuesService) GetParticipants(pid any, issue int64, options ...RequestOptionFunc) ([]*BasicUser, *Response, error)

GetParticipants gets a list of issue participants.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-participants-in-an-issue

func (*IssuesService) GetTimeSpent added in v0.6.0 

func (s *IssuesService) GetTimeSpent(pid any, issue int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)

GetTimeSpent gets the spent time for a single project issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#get-time-tracking-stats

func (*IssuesService) ListGroupIssues added in v0.6.0 

func (s *IssuesService) ListGroupIssues(pid any, opt *ListGroupIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)

ListGroupIssues gets a list of group issues. This function accepts pagination parameters page and per_page to return the list of group issues.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-group-issues

func (*IssuesService) ListIssues 

func (s *IssuesService) ListIssues(opt *ListIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)

ListIssues gets all issues created by authenticated user. This function takes pagination parameters page and per_page to restrict the list of issues.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-issues

func (*IssuesService) ListMergeRequestsClosingIssue added in v0.10.6 

func (s *IssuesService) ListMergeRequestsClosingIssue(pid any, issue int64, opt *ListMergeRequestsClosingIssueOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)

ListMergeRequestsClosingIssue gets all the merge requests that will close issue when merged.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-merge-requests-that-close-a-particular-issue-on-merge

func (*IssuesService) ListMergeRequestsRelatedToIssue added in v0.116.0 

func (s *IssuesService) ListMergeRequestsRelatedToIssue(pid any, issue int64, opt *ListMergeRequestsRelatedToIssueOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)

ListMergeRequestsRelatedToIssue gets all the merge requests that are related to the issue

GitLab API docs: https://docs.gitlab.com/api/issues/#list-merge-requests-related-to-issue

func (*IssuesService) ListProjectIssues 

func (s *IssuesService) ListProjectIssues(pid any, opt *ListProjectIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)

ListProjectIssues gets a list of project issues. This function accepts pagination parameters page and per_page to return the list of project issues.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-project-issues

func (*IssuesService) MoveIssue added in v0.116.0 

func (s *IssuesService) MoveIssue(pid any, issue int64, opt *MoveIssueOptions, options ...RequestOptionFunc) (*Issue, *Response, error)

MoveIssue updates an existing project issue. This function is also used to mark an issue as closed.

GitLab API docs: https://docs.gitlab.com/api/issues/#move-an-issue

func (*IssuesService) ReorderIssue added in v0.116.0 

func (s *IssuesService) ReorderIssue(pid any, issue int64, opt *ReorderIssueOptions, options ...RequestOptionFunc) (*Issue, *Response, error)

ReorderIssue reorders an issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#reorder-an-issue

func (*IssuesService) ResetSpentTime added in v0.6.0 

func (s *IssuesService) ResetSpentTime(pid any, issue int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)

ResetSpentTime resets the spent time for a single project issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#reset-spent-time-for-an-issue

func (*IssuesService) ResetTimeEstimate added in v0.6.0 

func (s *IssuesService) ResetTimeEstimate(pid any, issue int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)

ResetTimeEstimate resets the time estimate for a single project issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#reset-the-time-estimate-for-an-issue

func (*IssuesService) SetTimeEstimate added in v0.6.0 

func (s *IssuesService) SetTimeEstimate(pid any, issue int64, opt *SetTimeEstimateOptions, options ...RequestOptionFunc) (*TimeStats, *Response, error)

SetTimeEstimate sets the time estimate for a single project issue.

GitLab API docs: https://docs.gitlab.com/api/issues/#set-a-time-estimate-for-an-issue

func (*IssuesService) SubscribeToIssue added in v0.11.2 

func (s *IssuesService) SubscribeToIssue(pid any, issue int64, options ...RequestOptionFunc) (*Issue, *Response, error)

SubscribeToIssue subscribes the authenticated user to the given issue to receive notifications. If the user is already subscribed to the issue, the status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/issues/#subscribe-to-an-issue

func (*IssuesService) UnsubscribeFromIssue added in v0.11.2 

func (s *IssuesService) UnsubscribeFromIssue(pid any, issue int64, options ...RequestOptionFunc) (*Issue, *Response, error)

UnsubscribeFromIssue unsubscribes the authenticated user from the given issue to not receive notifications from that merge request. If the user is not subscribed to the issue, status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/issues/#unsubscribe-from-an-issue

func (*IssuesService) UpdateIssue 

func (s *IssuesService) UpdateIssue(pid any, issue int64, opt *UpdateIssueOptions, options ...RequestOptionFunc) (*Issue, *Response, error)

UpdateIssue updates an existing project issue. This function is also used to mark an issue as closed.

GitLab API docs: https://docs.gitlab.com/api/issues/#edit-an-issue

type IssuesServiceInterface added in v0.126.0 

type IssuesServiceInterface interface {
	ListIssues(opt *ListIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)
	ListGroupIssues(pid any, opt *ListGroupIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)
	ListProjectIssues(pid any, opt *ListProjectIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)
	GetIssueByID(issue int64, options ...RequestOptionFunc) (*Issue, *Response, error)
	GetIssue(pid any, issue int64, options ...RequestOptionFunc) (*Issue, *Response, error)
	CreateIssue(pid any, opt *CreateIssueOptions, options ...RequestOptionFunc) (*Issue, *Response, error)
	UpdateIssue(pid any, issue int64, opt *UpdateIssueOptions, options ...RequestOptionFunc) (*Issue, *Response, error)
	DeleteIssue(pid any, issue int64, options ...RequestOptionFunc) (*Response, error)
	ReorderIssue(pid any, issue int64, opt *ReorderIssueOptions, options ...RequestOptionFunc) (*Issue, *Response, error)
	MoveIssue(pid any, issue int64, opt *MoveIssueOptions, options ...RequestOptionFunc) (*Issue, *Response, error)
	SubscribeToIssue(pid any, issue int64, options ...RequestOptionFunc) (*Issue, *Response, error)
	UnsubscribeFromIssue(pid any, issue int64, options ...RequestOptionFunc) (*Issue, *Response, error)
	CreateTodo(pid any, issue int64, options ...RequestOptionFunc) (*Todo, *Response, error)
	ListMergeRequestsClosingIssue(pid any, issue int64, opt *ListMergeRequestsClosingIssueOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)
	ListMergeRequestsRelatedToIssue(pid any, issue int64, opt *ListMergeRequestsRelatedToIssueOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)
	SetTimeEstimate(pid any, issue int64, opt *SetTimeEstimateOptions, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	ResetTimeEstimate(pid any, issue int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	AddSpentTime(pid any, issue int64, opt *AddSpentTimeOptions, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	ResetSpentTime(pid any, issue int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	GetTimeSpent(pid any, issue int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	GetParticipants(pid any, issue int64, options ...RequestOptionFunc) ([]*BasicUser, *Response, error)
}

type IssuesStatistics added in v0.116.0 

type IssuesStatistics struct {
	Statistics IssuesStatisticsStatistics `json:"statistics"`
}

IssuesStatistics represents a GitLab issues statistic.

GitLab API docs: https://docs.gitlab.com/api/issues_statistics/

func (IssuesStatistics) String added in v0.116.0 

func (n IssuesStatistics) String() string

type IssuesStatisticsCounts added in v1.0.0 

type IssuesStatisticsCounts struct {
	All    int64 `json:"all"`
	Closed int64 `json:"closed"`
	Opened int64 `json:"opened"`
}

IssuesStatisticsCounts represents a GitLab issues statistic counts.

GitLab API docs: https://docs.gitlab.com/api/issues_statistics/

type IssuesStatisticsService added in v0.116.0 

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

IssuesStatisticsService handles communication with the issues statistics related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/issues_statistics/

func (*IssuesStatisticsService) GetGroupIssuesStatistics added in v0.116.0 

func (s *IssuesStatisticsService) GetGroupIssuesStatistics(gid any, opt *GetGroupIssuesStatisticsOptions, options ...RequestOptionFunc) (*IssuesStatistics, *Response, error)

func (*IssuesStatisticsService) GetIssuesStatistics added in v0.116.0 

func (s *IssuesStatisticsService) GetIssuesStatistics(opt *GetIssuesStatisticsOptions, options ...RequestOptionFunc) (*IssuesStatistics, *Response, error)

func (*IssuesStatisticsService) GetProjectIssuesStatistics added in v0.116.0 

func (s *IssuesStatisticsService) GetProjectIssuesStatistics(pid any, opt *GetProjectIssuesStatisticsOptions, options ...RequestOptionFunc) (*IssuesStatistics, *Response, error)

type IssuesStatisticsServiceInterface added in v0.126.0 

type IssuesStatisticsServiceInterface interface {
	// GetIssuesStatistics gets issues statistics on all issues the authenticated
	// user has access to.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/issues_statistics/#get-issues-statistics
	GetIssuesStatistics(opt *GetIssuesStatisticsOptions, options ...RequestOptionFunc) (*IssuesStatistics, *Response, error)
	// GetGroupIssuesStatistics gets issues count statistics for given group.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/issues_statistics/#get-group-issues-statistics
	GetGroupIssuesStatistics(gid any, opt *GetGroupIssuesStatisticsOptions, options ...RequestOptionFunc) (*IssuesStatistics, *Response, error)
	// GetProjectIssuesStatistics gets issues count statistics for given project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/issues_statistics/#get-project-issues-statistics
	GetProjectIssuesStatistics(pid any, opt *GetProjectIssuesStatisticsOptions, options ...RequestOptionFunc) (*IssuesStatistics, *Response, error)
}

type IssuesStatisticsStatistics added in v1.0.0 

type IssuesStatisticsStatistics struct {
	Counts IssuesStatisticsCounts `json:"counts"`
}

IssuesStatisticsStatistics represents a GitLab issues statistic statistics.

GitLab API docs: https://docs.gitlab.com/api/issues_statistics/

type Iteration added in v0.116.0 

type Iteration struct {
	ID          int64      `json:"id"`
	IID         int64      `json:"iid"`
	Sequence    int64      `json:"sequence"`
	GroupID     int64      `json:"group_id"`
	Title       string     `json:"title"`
	Description string     `json:"description"`
	State       int64      `json:"state"`
	CreatedAt   *time.Time `json:"created_at"`
	UpdatedAt   *time.Time `json:"updated_at"`
	DueDate     *ISOTime   `json:"due_date"`
	StartDate   *ISOTime   `json:"start_date"`
	WebURL      string     `json:"web_url"`
}

Iteration represents a project issue iteration.

GitLab API docs: https://docs.gitlab.com/api/resource_iteration_events/

type IterationEvent added in v0.116.0 

type IterationEvent struct {
	ID           int64      `json:"id"`
	User         *BasicUser `json:"user"`
	CreatedAt    *time.Time `json:"created_at"`
	ResourceType string     `json:"resource_type"`
	ResourceID   int64      `json:"resource_id"`
	Iteration    *Iteration `json:"iteration"`
	Action       string     `json:"action"`
}

IterationEvent represents a resource iteration event.

GitLab API docs: https://docs.gitlab.com/api/resource_iteration_events/

type JenkinsCIService added in v0.7.5 

type JenkinsCIService struct {
	Service
	Properties *JenkinsCIServiceProperties `json:"properties"`
}

JenkinsCIService represents Jenkins CI service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#jenkins

type JenkinsCIServiceProperties added in v0.7.5 

type JenkinsCIServiceProperties struct {
	URL                   string `json:"jenkins_url"`
	EnableSSLVerification bool   `json:"enable_ssl_verification"`
	ProjectName           string `json:"project_name"`
	Username              string `json:"username"`
}

JenkinsCIServiceProperties represents Jenkins CI specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#jenkins

type JiraService added in v0.7.0 

type JiraService struct {
	Service
	Properties *JiraServiceProperties `json:"properties"`
}

JiraService represents Jira service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#jira-issues

type JiraServiceProperties added in v0.7.0 

type JiraServiceProperties struct {
	URL                          string   `json:"url"`
	APIURL                       string   `json:"api_url"`
	Username                     string   `json:"username" `
	Password                     string   `json:"password" `
	Active                       bool     `json:"active"`
	JiraAuthType                 int64    `json:"jira_auth_type"`
	JiraIssuePrefix              string   `json:"jira_issue_prefix"`
	JiraIssueRegex               string   `json:"jira_issue_regex"`
	JiraIssueTransitionAutomatic bool     `json:"jira_issue_transition_automatic"`
	JiraIssueTransitionID        string   `json:"jira_issue_transition_id"`
	CommitEvents                 bool     `json:"commit_events"`
	MergeRequestsEvents          bool     `json:"merge_requests_events"`
	CommentOnEventEnabled        bool     `json:"comment_on_event_enabled"`
	IssuesEnabled                bool     `json:"issues_enabled"`
	ProjectKeys                  []string `json:"project_keys" `
	UseInheritedSettings         bool     `json:"use_inherited_settings"`
}

JiraServiceProperties represents Jira specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#jira-issues

func (*JiraServiceProperties) UnmarshalJSON added in v0.116.0 

func (p *JiraServiceProperties) UnmarshalJSON(b []byte) error

UnmarshalJSON decodes the Jira Service Properties.

This allows support of JiraIssueTransitionID for both type string (>11.9) and float64 (<11.9)

type Job added in v0.6.0 

type Job struct {
	Commit            *Commit          `json:"commit"`
	Coverage          float64          `json:"coverage"`
	AllowFailure      bool             `json:"allow_failure"`
	CreatedAt         *time.Time       `json:"created_at"`
	StartedAt         *time.Time       `json:"started_at"`
	FinishedAt        *time.Time       `json:"finished_at"`
	ErasedAt          *time.Time       `json:"erased_at"`
	Duration          float64          `json:"duration"`
	QueuedDuration    float64          `json:"queued_duration"`
	ArtifactsExpireAt *time.Time       `json:"artifacts_expire_at"`
	TagList           []string         `json:"tag_list"`
	ID                int64            `json:"id"`
	Name              string           `json:"name"`
	Pipeline          JobPipeline      `json:"pipeline"`
	Ref               string           `json:"ref"`
	Artifacts         []JobArtifact    `json:"artifacts"`
	ArtifactsFile     JobArtifactsFile `json:"artifacts_file"`
	Runner            JobRunner        `json:"runner"`
	Stage             string           `json:"stage"`
	Status            string           `json:"status"`
	FailureReason     string           `json:"failure_reason"`
	Tag               bool             `json:"tag"`
	WebURL            string           `json:"web_url"`
	Project           *Project         `json:"project"`
	User              *User            `json:"user"`
}

Job represents a ci build.

GitLab API docs: https://docs.gitlab.com/api/jobs/

type JobArtifact added in v1.0.0 

type JobArtifact struct {
	FileType   string `json:"file_type"`
	Filename   string `json:"filename"`
	Size       int64  `json:"size"`
	FileFormat string `json:"file_format"`
}

JobArtifact represents a ci build artifact.

GitLab API docs: https://docs.gitlab.com/api/jobs/

type JobArtifactsFile added in v1.0.0 

type JobArtifactsFile struct {
	Filename string `json:"filename"`
	Size     int64  `json:"size"`
}

JobArtifactsFile represents a ci build artifacts file.

GitLab API docs: https://docs.gitlab.com/api/jobs/

type JobEvent added in v0.116.0 

type JobEvent struct {
	ObjectKind          string              `json:"object_kind"`
	Ref                 string              `json:"ref"`
	Tag                 bool                `json:"tag"`
	BeforeSHA           string              `json:"before_sha"`
	SHA                 string              `json:"sha"`
	BuildID             int64               `json:"build_id"`
	BuildName           string              `json:"build_name"`
	BuildStage          string              `json:"build_stage"`
	BuildStatus         string              `json:"build_status"`
	BuildCreatedAt      string              `json:"build_created_at"`
	BuildStartedAt      string              `json:"build_started_at"`
	BuildFinishedAt     string              `json:"build_finished_at"`
	BuildDuration       float64             `json:"build_duration"`
	BuildQueuedDuration float64             `json:"build_queued_duration"`
	BuildAllowFailure   bool                `json:"build_allow_failure"`
	BuildFailureReason  string              `json:"build_failure_reason"`
	RetriesCount        int64               `json:"retries_count"`
	PipelineID          int64               `json:"pipeline_id"`
	ProjectID           int64               `json:"project_id"`
	ProjectName         string              `json:"project_name"`
	User                *EventUser          `json:"user"`
	Commit              JobEventCommit      `json:"commit"`
	Repository          *Repository         `json:"repository"`
	Runner              JobEventRunner      `json:"runner"`
	Environment         EventEnvironment    `json:"environment"`
	SourcePipeline      EventSourcePipeline `json:"source_pipeline"`
}

JobEvent represents a job event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#job-events

type JobEventCommit added in v1.0.0 

type JobEventCommit struct {
	ID          int64  `json:"id"`
	Name        string `json:"name"`
	SHA         string `json:"sha"`
	Message     string `json:"message"`
	AuthorName  string `json:"author_name"`
	AuthorEmail string `json:"author_email"`
	AuthorURL   string `json:"author_url"`
	Status      string `json:"status"`
	Duration    int64  `json:"duration"`
	StartedAt   string `json:"started_at"`
	FinishedAt  string `json:"finished_at"`
}

type JobEventRunner added in v1.0.0 

type JobEventRunner struct {
	ID          int64    `json:"id"`
	Active      bool     `json:"active"`
	RunnerType  string   `json:"runner_type"`
	IsShared    bool     `json:"is_shared"`
	Description string   `json:"description"`
	Tags        []string `json:"tags"`
}

type JobPipeline added in v1.0.0 

type JobPipeline struct {
	ID        int64  `json:"id"`
	ProjectID int64  `json:"project_id"`
	Ref       string `json:"ref"`
	Sha       string `json:"sha"`
	Status    string `json:"status"`
}

JobPipeline represents a ci build pipeline.

GitLab API docs: https://docs.gitlab.com/api/jobs/

type JobRunner added in v1.0.0 

type JobRunner struct {
	ID          int64  `json:"id"`
	Description string `json:"description"`
	Active      bool   `json:"active"`
	IsShared    bool   `json:"is_shared"`
	Name        string `json:"name"`
}

JobRunner represents a ci build runner.

GitLab API docs: https://docs.gitlab.com/api/jobs/

type JobStats added in v0.8.1 

type JobStats struct {
	Jobs JobStatsJobs `json:"jobs"`
}

JobStats represents the GitLab sidekiq job stats.

GitLab API docs: https://docs.gitlab.com/api/sidekiq_metrics/#get-the-current-job-statistics

type JobStatsJobs added in v1.0.0 

type JobStatsJobs struct {
	Processed int64 `json:"processed"`
	Failed    int64 `json:"failed"`
	Enqueued  int64 `json:"enqueued"`
}

JobStatsJobs represents the GitLab sidekiq job stats jobs.

GitLab API docs: https://docs.gitlab.com/api/sidekiq_metrics/#get-the-current-job-statistics

type JobTokenAccessSettings added in v0.116.0 

type JobTokenAccessSettings struct {
	InboundEnabled bool `json:"inbound_enabled"`
}

JobTokenAccessSettings represents job token access attributes for this project.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/

type JobTokenAllowlistItem added in v0.116.0 

type JobTokenAllowlistItem struct {
	SourceProjectID int64 `json:"source_project_id"`
	TargetGroupID   int64 `json:"target_group_id"`
}

JobTokenAllowlistItem represents a single job token allowlist item.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/

type JobTokenAuthSource added in v0.132.0 

type JobTokenAuthSource struct {
	Token string
}

JobTokenAuthSource used as an AuthSource for CI Job Tokens

func (JobTokenAuthSource) Header added in v0.132.0 

func (s JobTokenAuthSource) Header(_ context.Context) (string, string, error)

func (JobTokenAuthSource) Init added in v0.132.0 

func (JobTokenAuthSource) Init(context.Context, *Client) error

type JobTokenInboundAllowItem added in v0.116.0 

type JobTokenInboundAllowItem struct {
	SourceProjectID int64 `json:"source_project_id"`
	TargetProjectID int64 `json:"target_project_id"`
}

JobTokenInboundAllowItem represents a single job token inbound allowlist item.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/

type JobTokenInboundAllowOptions added in v0.116.0 

type JobTokenInboundAllowOptions struct {
	TargetProjectID *int64 `url:"target_project_id,omitempty" json:"target_project_id,omitempty"`
}

JobTokenInboundAllowOptions represents the available AddProjectToJobScopeAllowList() options.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#add-a-project-to-a-cicd-job-token-inbound-allowlist

type JobTokenScopeService added in v0.116.0 

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

JobTokenScopeService handles communication with project CI settings such as token permissions.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/

func (*JobTokenScopeService) AddGroupToJobTokenAllowlist added in v0.116.0 

func (j *JobTokenScopeService) AddGroupToJobTokenAllowlist(pid any, opt *AddGroupToJobTokenAllowlistOptions, options ...RequestOptionFunc) (*JobTokenAllowlistItem, *Response, error)

AddGroupToJobTokenAllowlist adds a new group to a project's job token inbound groups allow list.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#add-a-group-to-a-cicd-job-token-allowlist

func (*JobTokenScopeService) AddProjectToJobScopeAllowList added in v0.116.0 

func (j *JobTokenScopeService) AddProjectToJobScopeAllowList(pid any, opt *JobTokenInboundAllowOptions, options ...RequestOptionFunc) (*JobTokenInboundAllowItem, *Response, error)

AddProjectToJobScopeAllowList adds a new project to a project's job token inbound allow list.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#add-a-project-to-a-cicd-job-token-inbound-allowlist

func (*JobTokenScopeService) GetJobTokenAllowlistGroups added in v0.116.0 

func (j *JobTokenScopeService) GetJobTokenAllowlistGroups(pid any, opt *GetJobTokenAllowlistGroupsOptions, options ...RequestOptionFunc) ([]*Group, *Response, error)

GetJobTokenAllowlistGroups fetches the CI/CD job token allowlist groups (job token scopes) of a project.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#get-a-projects-cicd-job-token-allowlist-of-groups

func (*JobTokenScopeService) GetProjectJobTokenAccessSettings added in v0.116.0 

func (j *JobTokenScopeService) GetProjectJobTokenAccessSettings(pid any, options ...RequestOptionFunc) (*JobTokenAccessSettings, *Response, error)

GetProjectJobTokenAccessSettings fetch the CI/CD job token access settings (job token scope) of a project.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#get-a-projects-cicd-job-token-access-settings

func (*JobTokenScopeService) GetProjectJobTokenInboundAllowList added in v0.116.0 

func (j *JobTokenScopeService) GetProjectJobTokenInboundAllowList(pid any, opt *GetJobTokenInboundAllowListOptions, options ...RequestOptionFunc) ([]*Project, *Response, error)

GetProjectJobTokenInboundAllowList fetches the CI/CD job token inbound allowlist (job token scope) of a project.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#get-a-projects-cicd-job-token-inbound-allowlist

func (*JobTokenScopeService) PatchProjectJobTokenAccessSettings added in v0.116.0 

func (j *JobTokenScopeService) PatchProjectJobTokenAccessSettings(pid any, opt *PatchProjectJobTokenAccessSettingsOptions, options ...RequestOptionFunc) (*Response, error)

PatchProjectJobTokenAccessSettings patch the Limit access to this project setting (job token scope) of a project.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#patch-a-projects-cicd-job-token-access-settings

func (*JobTokenScopeService) RemoveGroupFromJobTokenAllowlist added in v0.116.0 

func (j *JobTokenScopeService) RemoveGroupFromJobTokenAllowlist(pid any, targetGroup int64, options ...RequestOptionFunc) (*Response, error)

RemoveGroupFromJobTokenAllowlist removes a group from a project's job token inbound groups allow list.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#remove-a-group-from-a-cicd-job-token-allowlist

func (*JobTokenScopeService) RemoveProjectFromJobScopeAllowList added in v0.116.0 

func (j *JobTokenScopeService) RemoveProjectFromJobScopeAllowList(pid any, targetProject int64, options ...RequestOptionFunc) (*Response, error)

RemoveProjectFromJobScopeAllowList removes a project from a project's job token inbound allow list.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#remove-a-project-from-a-cicd-job-token-inbound-allowlist

type JobTokenScopeServiceInterface added in v0.126.0 

type JobTokenScopeServiceInterface interface {
	GetProjectJobTokenAccessSettings(pid any, options ...RequestOptionFunc) (*JobTokenAccessSettings, *Response, error)
	PatchProjectJobTokenAccessSettings(pid any, opt *PatchProjectJobTokenAccessSettingsOptions, options ...RequestOptionFunc) (*Response, error)
	GetProjectJobTokenInboundAllowList(pid any, opt *GetJobTokenInboundAllowListOptions, options ...RequestOptionFunc) ([]*Project, *Response, error)
	AddProjectToJobScopeAllowList(pid any, opt *JobTokenInboundAllowOptions, options ...RequestOptionFunc) (*JobTokenInboundAllowItem, *Response, error)
	RemoveProjectFromJobScopeAllowList(pid any, targetProject int64, options ...RequestOptionFunc) (*Response, error)
	GetJobTokenAllowlistGroups(pid any, opt *GetJobTokenAllowlistGroupsOptions, options ...RequestOptionFunc) ([]*Group, *Response, error)
	AddGroupToJobTokenAllowlist(pid any, opt *AddGroupToJobTokenAllowlistOptions, options ...RequestOptionFunc) (*JobTokenAllowlistItem, *Response, error)
	RemoveGroupFromJobTokenAllowlist(pid any, targetGroup int64, options ...RequestOptionFunc) (*Response, error)
}

type JobVariableOptions added in v0.116.0 

type JobVariableOptions struct {
	Key          *string            `url:"key,omitempty" json:"key,omitempty"`
	Value        *string            `url:"value,omitempty" json:"value,omitempty"`
	VariableType *VariableTypeValue `url:"variable_type,omitempty" json:"variable_type,omitempty"`
}

JobVariableOptions represents a single job variable.

GitLab API docs: https://docs.gitlab.com/api/jobs/#run-a-job

type JobsService added in v0.6.0 

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

JobsService handles communication with the ci builds related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/jobs/

func (*JobsService) CancelJob added in v0.6.0 

func (s *JobsService) CancelJob(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)

func (*JobsService) DeleteArtifacts added in v0.116.0 

func (s *JobsService) DeleteArtifacts(pid any, jobID int64, options ...RequestOptionFunc) (*Response, error)

func (*JobsService) DeleteProjectArtifacts added in v0.116.0 

func (s *JobsService) DeleteProjectArtifacts(pid any, options ...RequestOptionFunc) (*Response, error)

func (*JobsService) DownloadArtifactsFile added in v0.6.0 

func (s *JobsService) DownloadArtifactsFile(pid any, refName string, opt *DownloadArtifactsFileOptions, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)

func (*JobsService) DownloadSingleArtifactsFile added in v0.11.1 

func (s *JobsService) DownloadSingleArtifactsFile(pid any, jobID int64, artifactPath string, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)

func (*JobsService) DownloadSingleArtifactsFileByTagOrBranch added in v0.116.0 

func (s *JobsService) DownloadSingleArtifactsFileByTagOrBranch(pid any, refName string, artifactPath string, opt *DownloadArtifactsFileOptions, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)

func (*JobsService) EraseJob added in v0.6.0 

func (s *JobsService) EraseJob(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)

func (*JobsService) GetJob added in v0.6.0 

func (s *JobsService) GetJob(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)

func (*JobsService) GetJobArtifacts added in v0.6.0 

func (s *JobsService) GetJobArtifacts(pid any, jobID int64, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)

func (*JobsService) GetJobTokensJob added in v0.116.0 

func (s *JobsService) GetJobTokensJob(opts *GetJobTokensJobOptions, options ...RequestOptionFunc) (*Job, *Response, error)

func (*JobsService) GetTraceFile added in v0.6.0 

func (s *JobsService) GetTraceFile(pid any, jobID int64, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)

func (*JobsService) KeepArtifacts added in v0.6.0 

func (s *JobsService) KeepArtifacts(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)

func (*JobsService) ListPipelineBridges added in v0.116.0 

func (s *JobsService) ListPipelineBridges(pid any, pipelineID int64, opts *ListJobsOptions, options ...RequestOptionFunc) ([]*Bridge, *Response, error)

func (*JobsService) ListPipelineJobs added in v0.6.0 

func (s *JobsService) ListPipelineJobs(pid any, pipelineID int64, opts *ListJobsOptions, options ...RequestOptionFunc) ([]*Job, *Response, error)

func (*JobsService) ListProjectJobs added in v0.6.0 

func (s *JobsService) ListProjectJobs(pid any, opts *ListJobsOptions, options ...RequestOptionFunc) ([]*Job, *Response, error)

func (*JobsService) PlayJob added in v0.6.0 

func (s *JobsService) PlayJob(pid any, jobID int64, opt *PlayJobOptions, options ...RequestOptionFunc) (*Job, *Response, error)

func (*JobsService) RetryJob added in v0.6.0 

func (s *JobsService) RetryJob(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)

type JobsServiceInterface added in v0.126.0 

type JobsServiceInterface interface {
	// ListProjectJobs gets a list of jobs in a project.
	//
	// The scope of jobs to show, one or array of: created, pending, running,
	// failed, success, canceled, skipped; showing all jobs if none provided
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/jobs/#list-project-jobs
	ListProjectJobs(pid any, opts *ListJobsOptions, options ...RequestOptionFunc) ([]*Job, *Response, error)
	// ListPipelineJobs gets a list of jobs for specific pipeline in a
	// project. If the pipeline ID is not found, it will respond with 404.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/jobs/#list-pipeline-jobs
	ListPipelineJobs(pid any, pipelineID int64, opts *ListJobsOptions, options ...RequestOptionFunc) ([]*Job, *Response, error)
	// ListPipelineBridges gets a list of bridges for specific pipeline in a
	// project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/jobs/#list-pipeline-trigger-jobs
	ListPipelineBridges(pid any, pipelineID int64, opts *ListJobsOptions, options ...RequestOptionFunc) ([]*Bridge, *Response, error)
	// GetJobTokensJob retrieves the job that generated a job token.
	//
	// GitLab API docs: https://docs.gitlab.com/api/jobs/#get-job-tokens-job
	GetJobTokensJob(opts *GetJobTokensJobOptions, options ...RequestOptionFunc) (*Job, *Response, error)
	// GetJob gets a single job of a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/jobs/#get-a-single-job
	GetJob(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)
	// GetJobArtifacts gets jobs artifacts of a project
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/job_artifacts/#get-job-artifacts
	GetJobArtifacts(pid any, jobID int64, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)
	// DownloadArtifactsFile downloads the artifacts file from the given
	// reference name and job provided the job finished successfully.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/job_artifacts/#download-the-artifacts-archive
	DownloadArtifactsFile(pid any, refName string, opt *DownloadArtifactsFileOptions, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)
	// DownloadSingleArtifactsFile downloads a file from the artifacts from the
	// given reference name and job provided the job finished successfully.
	// Only a single file is going to be extracted from the archive and streamed
	// to a client.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/job_artifacts/#download-a-single-artifact-file-by-job-id
	DownloadSingleArtifactsFile(pid any, jobID int64, artifactPath string, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)
	// DownloadSingleArtifactsFileByTagOrBranch downloads a single file from
	// a job's artifacts in the latest successful pipeline using the reference name.
	// The file is extracted from the archive and streamed to the client.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/job_artifacts/#download-a-single-artifact-file-from-specific-tag-or-branch
	DownloadSingleArtifactsFileByTagOrBranch(pid any, refName string, artifactPath string, opt *DownloadArtifactsFileOptions, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)
	// GetTraceFile gets a trace of a specific job of a project
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/jobs/#get-a-log-file
	GetTraceFile(pid any, jobID int64, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)
	// CancelJob cancels a single job of a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/jobs/#cancel-a-job
	CancelJob(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)
	// RetryJob retries a single job of a project
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/jobs/#retry-a-job
	RetryJob(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)
	// EraseJob erases a single job of a project, removes a job
	// artifacts and a job trace.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/jobs/#erase-a-job
	EraseJob(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)
	// KeepArtifacts prevents artifacts from being deleted when
	// expiration is set.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/job_artifacts/#keep-artifacts
	KeepArtifacts(pid any, jobID int64, options ...RequestOptionFunc) (*Job, *Response, error)
	// PlayJob triggers a manual action to start a job.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/jobs/#run-a-job
	PlayJob(pid any, jobID int64, opt *PlayJobOptions, options ...RequestOptionFunc) (*Job, *Response, error)
	// DeleteArtifacts deletes artifacts of a job
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/job_artifacts/#delete-job-artifacts
	DeleteArtifacts(pid any, jobID int64, options ...RequestOptionFunc) (*Response, error)
	// DeleteProjectArtifacts deletes artifacts eligible for deletion in a project
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/job_artifacts/#delete-job-artifacts
	DeleteProjectArtifacts(pid any, options ...RequestOptionFunc) (*Response, error)
}

type Key added in v0.11.0 

type Key struct {
	ID        int64      `json:"id"`
	Title     string     `json:"title"`
	Key       string     `json:"key"`
	CreatedAt *time.Time `json:"created_at"`
	User      User       `json:"user"`
}

Key represents a GitLab user's SSH key.

GitLab API docs: https://docs.gitlab.com/api/keys/

type KeySystemEvent added in v0.116.0 

type KeySystemEvent struct {
	BaseSystemEvent
	ID       int64  `json:"id"`
	Username string `json:"username"`
	Key      string `json:"key"`
}

KeySystemEvent represents a key system event.

GitLab API docs: https://docs.gitlab.com/administration/system_hooks/

type KeysService added in v0.11.0 

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

KeysService handles communication with the keys related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/keys/

func (*KeysService) GetKeyByFingerprint added in v0.116.0 

func (s *KeysService) GetKeyByFingerprint(opt *GetKeyByFingerprintOptions, options ...RequestOptionFunc) (*Key, *Response, error)

GetKeyByFingerprint gets a specific SSH key or deploy key by fingerprint along with the associated user information.

GitLab API docs: https://docs.gitlab.com/api/keys/#get-user-by-fingerprint-of-ssh-key https://docs.gitlab.com/api/keys/#get-user-by-deploy-key-fingerprint

func (*KeysService) GetKeyWithUser added in v0.11.0 

func (s *KeysService) GetKeyWithUser(key int64, options ...RequestOptionFunc) (*Key, *Response, error)

GetKeyWithUser gets a single key by id along with the associated user information.

GitLab API docs: https://docs.gitlab.com/api/keys/#get-ssh-key-with-user-by-id-of-an-ssh-key

type KeysServiceInterface added in v0.126.0 

type KeysServiceInterface interface {
	GetKeyWithUser(key int64, options ...RequestOptionFunc) (*Key, *Response, error)
	GetKeyByFingerprint(opt *GetKeyByFingerprintOptions, options ...RequestOptionFunc) (*Key, *Response, error)
}
type LDAPGroupLink struct {
	CN           string           `json:"cn"`
	Filter       string           `json:"filter"`
	GroupAccess  AccessLevelValue `json:"group_access"`
	Provider     string           `json:"provider"`
	MemberRoleID int64            `json:"member_role_id"`
}

LDAPGroupLink represents a GitLab LDAP group link.

GitLab API docs: https://docs.gitlab.com/api/group_ldap_links/

type Label 

type Label struct {
	ID                     int64  `json:"id"`
	Name                   string `json:"name"`
	Color                  string `json:"color"`
	TextColor              string `json:"text_color"`
	Description            string `json:"description"`
	OpenIssuesCount        int64  `json:"open_issues_count"`
	ClosedIssuesCount      int64  `json:"closed_issues_count"`
	OpenMergeRequestsCount int64  `json:"open_merge_requests_count"`
	Subscribed             bool   `json:"subscribed"`
	Priority               int64  `json:"priority"`
	IsProjectLabel         bool   `json:"is_project_label"`
}

Label represents a GitLab label.

GitLab API docs: https://docs.gitlab.com/api/labels/

func (Label) String 

func (l Label) String() string

func (*Label) UnmarshalJSON added in v0.11.3 

func (l *Label) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type LabelDetails added in v0.116.0 

type LabelDetails struct {
	ID              int64  `json:"id"`
	Name            string `json:"name"`
	Color           string `json:"color"`
	Description     string `json:"description"`
	DescriptionHTML string `json:"description_html"`
	TextColor       string `json:"text_color"`
}

LabelDetails represents detailed label information.

type LabelEvent added in v0.116.0 

type LabelEvent struct {
	ID           int64           `json:"id"`
	Action       string          `json:"action"`
	CreatedAt    *time.Time      `json:"created_at"`
	ResourceType string          `json:"resource_type"`
	ResourceID   int64           `json:"resource_id"`
	User         BasicUser       `json:"user"`
	Label        LabelEventLabel `json:"label"`
}

LabelEvent represents a resource label event.

GitLab API docs: https://docs.gitlab.com/api/resource_label_events/#get-single-issue-label-event

type LabelEventLabel added in v1.0.0 

type LabelEventLabel struct {
	ID          int64  `json:"id"`
	Name        string `json:"name"`
	Color       string `json:"color"`
	TextColor   string `json:"text_color"`
	Description string `json:"description"`
}

LabelEventLabel represents a resource label event label.

GitLab API docs: https://docs.gitlab.com/api/resource_label_events/#get-single-issue-label-event

type LabelID added in v1.19.0 

type LabelID struct {
	Value any
}

type LabelOptions added in v0.116.0 

type LabelOptions []string

LabelOptions is a custom type with specific marshaling characteristics.

func (*LabelOptions) EncodeValues added in v0.116.0 

func (l *LabelOptions) EncodeValues(key string, v *url.Values) error

EncodeValues implements the query.EncodeValues interface.

func (*LabelOptions) MarshalJSON added in v0.116.0 

func (l *LabelOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*LabelOptions) UnmarshalJSON added in v0.116.0 

func (l *LabelOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type Labels 

type Labels []string

Labels represents a list of labels.

type LabelsService 

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

LabelsService handles communication with the label related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/labels/

func (*LabelsService) CreateLabel 

func (s *LabelsService) CreateLabel(pid any, opt *CreateLabelOptions, options ...RequestOptionFunc) (*Label, *Response, error)

CreateLabel creates a new label for given repository with given name and color.

GitLab API docs: https://docs.gitlab.com/api/labels/#create-a-new-label

func (*LabelsService) DeleteLabel 

func (s *LabelsService) DeleteLabel(pid any, lid any, opt *DeleteLabelOptions, options ...RequestOptionFunc) (*Response, error)

DeleteLabel deletes a label given by its name or ID.

GitLab API docs: https://docs.gitlab.com/api/labels/#delete-a-label

func (*LabelsService) GetLabel added in v0.116.0 

func (s *LabelsService) GetLabel(pid any, lid any, options ...RequestOptionFunc) (*Label, *Response, error)

GetLabel get a single label for a given project.

GitLab API docs: https://docs.gitlab.com/api/labels/#get-a-single-project-label

func (*LabelsService) ListLabels 

func (s *LabelsService) ListLabels(pid any, opt *ListLabelsOptions, options ...RequestOptionFunc) ([]*Label, *Response, error)

ListLabels gets all labels for given project.

GitLab API docs: https://docs.gitlab.com/api/labels/#list-labels

func (*LabelsService) PromoteLabel added in v0.116.0 

func (s *LabelsService) PromoteLabel(pid any, lid any, options ...RequestOptionFunc) (*Response, error)

PromoteLabel Promotes a project label to a group label.

GitLab API docs: https://docs.gitlab.com/api/labels/#promote-a-project-label-to-a-group-label

func (*LabelsService) SubscribeToLabel added in v0.7.4 

func (s *LabelsService) SubscribeToLabel(pid any, lid any, options ...RequestOptionFunc) (*Label, *Response, error)

SubscribeToLabel subscribes the authenticated user to a label to receive notifications. If the user is already subscribed to the label, the status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/labels/#subscribe-to-a-label

func (*LabelsService) UnsubscribeFromLabel added in v0.7.4 

func (s *LabelsService) UnsubscribeFromLabel(pid any, lid any, options ...RequestOptionFunc) (*Response, error)

UnsubscribeFromLabel unsubscribes the authenticated user from a label to not receive notifications from it. If the user is not subscribed to the label, the status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/labels/#unsubscribe-from-a-label

func (*LabelsService) UpdateLabel 

func (s *LabelsService) UpdateLabel(pid any, lid any, opt *UpdateLabelOptions, options ...RequestOptionFunc) (*Label, *Response, error)

UpdateLabel updates an existing label with new name or now color. At least one parameter is required, to update the label.

GitLab API docs: https://docs.gitlab.com/api/labels/#edit-an-existing-label

type LabelsServiceInterface added in v0.126.0 

type LabelsServiceInterface interface {
	ListLabels(pid any, opt *ListLabelsOptions, options ...RequestOptionFunc) ([]*Label, *Response, error)
	GetLabel(pid any, lid any, options ...RequestOptionFunc) (*Label, *Response, error)
	CreateLabel(pid any, opt *CreateLabelOptions, options ...RequestOptionFunc) (*Label, *Response, error)
	DeleteLabel(pid any, lid any, opt *DeleteLabelOptions, options ...RequestOptionFunc) (*Response, error)
	UpdateLabel(pid any, lid any, opt *UpdateLabelOptions, options ...RequestOptionFunc) (*Label, *Response, error)
	SubscribeToLabel(pid any, lid any, options ...RequestOptionFunc) (*Label, *Response, error)
	UnsubscribeFromLabel(pid any, lid any, options ...RequestOptionFunc) (*Response, error)
	PromoteLabel(pid any, lid any, options ...RequestOptionFunc) (*Response, error)
}

type LastPipeline added in v0.116.0 

type LastPipeline struct {
	ID     int64  `json:"id"`
	SHA    string `json:"sha"`
	Ref    string `json:"ref"`
	Status string `json:"status"`
	WebURL string `json:"web_url"`
}

LastPipeline represents the last pipeline ran by schedule this will be returned only for individual schedule get operation

type License added in v0.11.4 

type License struct {
	ID               int64           `json:"id"`
	Plan             string          `json:"plan"`
	CreatedAt        *time.Time      `json:"created_at"`
	StartsAt         *ISOTime        `json:"starts_at"`
	ExpiresAt        *ISOTime        `json:"expires_at"`
	HistoricalMax    int64           `json:"historical_max"`
	MaximumUserCount int64           `json:"maximum_user_count"`
	Expired          bool            `json:"expired"`
	Overage          int64           `json:"overage"`
	UserLimit        int64           `json:"user_limit"`
	ActiveUsers      int64           `json:"active_users"`
	Licensee         LicenseLicensee `json:"licensee"`
	// Add on codes that may occur in legacy licenses that don't have a plan yet.
	// https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/models/license.rb
	AddOns LicenseAddOns `json:"add_ons"`
}

License represents a GitLab license.

GitLab API docs: https://docs.gitlab.com/api/license/

func (License) String added in v0.11.4 

func (l License) String() string

type LicenseAddOns added in v1.0.0 

type LicenseAddOns struct {
	GitLabAuditorUser int64 `json:"GitLab_Auditor_User"`
	GitLabDeployBoard int64 `json:"GitLab_DeployBoard"`
	GitLabFileLocks   int64 `json:"GitLab_FileLocks"`
	GitLabGeo         int64 `json:"GitLab_Geo"`
	GitLabServiceDesk int64 `json:"GitLab_ServiceDesk"`
}

LicenseAddOns represents a GitLab license add ons.

GitLab API docs: https://docs.gitlab.com/api/license/

func (LicenseAddOns) String added in v1.0.0 

func (a LicenseAddOns) String() string

type LicenseLicensee added in v1.0.0 

type LicenseLicensee struct {
	Name    string `json:"Name"`
	Company string `json:"Company"`
	Email   string `json:"Email"`
}

LicenseLicensee represents a GitLab license licensee.

GitLab API docs: https://docs.gitlab.com/api/license/

func (LicenseLicensee) String added in v1.0.0 

func (l LicenseLicensee) String() string

type LicenseService added in v0.11.4 

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

LicenseService handles communication with the license related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/license/

func (*LicenseService) AddLicense added in v0.11.4 

func (s *LicenseService) AddLicense(opt *AddLicenseOptions, options ...RequestOptionFunc) (*License, *Response, error)

AddLicense adds a new license.

GitLab API docs: https://docs.gitlab.com/api/license/#add-a-new-license

func (*LicenseService) DeleteLicense added in v0.116.0 

func (s *LicenseService) DeleteLicense(licenseID int64, options ...RequestOptionFunc) (*Response, error)

DeleteLicense deletes an existing license.

GitLab API docs: https://docs.gitlab.com/api/license/#delete-a-license

func (*LicenseService) GetLicense added in v0.11.4 

func (s *LicenseService) GetLicense(options ...RequestOptionFunc) (*License, *Response, error)

GetLicense retrieves information about the current license.

GitLab API docs: https://docs.gitlab.com/api/license/#retrieve-information-about-the-current-license

type LicenseServiceInterface added in v0.126.0 

type LicenseServiceInterface interface {
	GetLicense(options ...RequestOptionFunc) (*License, *Response, error)
	AddLicense(opt *AddLicenseOptions, options ...RequestOptionFunc) (*License, *Response, error)
	DeleteLicense(licenseID int64, options ...RequestOptionFunc) (*Response, error)
}

type LicenseTemplate added in v0.11.1 

type LicenseTemplate struct {
	Key         string   `json:"key"`
	Name        string   `json:"name"`
	Nickname    string   `json:"nickname"`
	Featured    bool     `json:"featured"`
	HTMLURL     string   `json:"html_url"`
	SourceURL   string   `json:"source_url"`
	Description string   `json:"description"`
	Conditions  []string `json:"conditions"`
	Permissions []string `json:"permissions"`
	Limitations []string `json:"limitations"`
	Content     string   `json:"content"`
}

LicenseTemplate represents a license template.

GitLab API docs: https://docs.gitlab.com/api/templates/licenses/

type LicenseTemplatesService added in v0.11.1 

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

LicenseTemplatesService handles communication with the license templates related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/templates/licenses/

func (*LicenseTemplatesService) GetLicenseTemplate added in v0.11.1 

func (s *LicenseTemplatesService) GetLicenseTemplate(template string, opt *GetLicenseTemplateOptions, options ...RequestOptionFunc) (*LicenseTemplate, *Response, error)

GetLicenseTemplate get a single license template. You can pass parameters to replace the license placeholder.

GitLab API docs: https://docs.gitlab.com/api/templates/licenses/#single-license-template

func (*LicenseTemplatesService) ListLicenseTemplates added in v0.11.1 

func (s *LicenseTemplatesService) ListLicenseTemplates(opt *ListLicenseTemplatesOptions, options ...RequestOptionFunc) ([]*LicenseTemplate, *Response, error)

ListLicenseTemplates get all license templates.

GitLab API docs: https://docs.gitlab.com/api/templates/licenses/#list-license-templates

type LicenseTemplatesServiceInterface added in v0.126.0 

type LicenseTemplatesServiceInterface interface {
	ListLicenseTemplates(opt *ListLicenseTemplatesOptions, options ...RequestOptionFunc) ([]*LicenseTemplate, *Response, error)
	GetLicenseTemplate(template string, opt *GetLicenseTemplateOptions, options ...RequestOptionFunc) (*LicenseTemplate, *Response, error)
}

type LinePosition added in v0.116.0 

type LinePosition struct {
	LineCode string `json:"line_code"`
	Type     string `json:"type"`
	OldLine  int64  `json:"old_line"`
	NewLine  int64  `json:"new_line"`
}

LinePosition represents a position in a line range.

type LinePositionOptions added in v0.116.0 

type LinePositionOptions struct {
	LineCode *string `url:"line_code,omitempty" json:"line_code,omitempty"`
	Type     *string `url:"type,omitempty" json:"type,omitempty"`
	OldLine  *int64  `url:"old_line,omitempty" json:"old_line,omitempty"`
	NewLine  *int64  `url:"new_line,omitempty" json:"new_line,omitempty"`
}

LinePositionOptions represents the line position option of a discussion.

type LineRange added in v0.116.0 

type LineRange struct {
	StartRange *LinePosition `json:"start"`
	EndRange   *LinePosition `json:"end"`
}

LineRange represents the range of a note.

type LineRangeOptions added in v0.116.0 

type LineRangeOptions struct {
	Start *LinePositionOptions `url:"start,omitempty" json:"start,omitempty"`
	End   *LinePositionOptions `url:"end,omitempty" json:"end,omitempty"`
}

LineRangeOptions represents the line range option of a discussion.

type LinkTypeValue added in v0.116.0 

type LinkTypeValue string

LinkTypeValue represents a release link type. 

const (
	ImageLinkType   LinkTypeValue = "image"
	OtherLinkType   LinkTypeValue = "other"
	PackageLinkType LinkTypeValue = "package"
	RunbookLinkType LinkTypeValue = "runbook"
)

List of available release link types.

GitLab API docs: https://docs.gitlab.com/api/releases/links/#create-a-release-link 

type Links struct {
	Self          string `json:"self"`
	Issues        string `json:"issues"`
	MergeRequests string `json:"merge_requests"`
	RepoBranches  string `json:"repo_branches"`
	Labels        string `json:"labels"`
	Events        string `json:"events"`
	Members       string `json:"members"`
	ClusterAgents string `json:"cluster_agents"`
}

Links represents a project web links for self, issues, merge_requests, repo_branches, labels, events, members.

type LintResult added in v0.7.5 

type LintResult struct {
	Status     string   `json:"status"`
	Errors     []string `json:"errors"`
	Warnings   []string `json:"warnings"`
	MergedYaml string   `json:"merged_yaml"`
}

LintResult represents the linting results.

GitLab API docs: https://docs.gitlab.com/api/lint/

type ListAccessRequestsOptions added in v0.11.1 

type ListAccessRequestsOptions struct {
	ListOptions
}

ListAccessRequestsOptions represents the available ListProjectAccessRequests() or ListGroupAccessRequests() options.

GitLab API docs: https://docs.gitlab.com/api/access_requests/#list-access-requests-for-a-group-or-project

type ListActiveIntegrationsOptions added in v0.135.0 

type ListActiveIntegrationsOptions struct {
	ListOptions
}

ListActiveIntegrationsOptions represents the available ListActiveIntegrations() options.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#list-all-active-integrations

type ListAgentTokensOptions added in v0.116.0 

type ListAgentTokensOptions struct {
	ListOptions
}

ListAgentTokensOptions represents the available ListAgentTokens() options.

GitLab API docs: https://docs.gitlab.com/api/cluster_agents/#list-tokens-for-an-agent

type ListAgentsOptions added in v0.116.0 

type ListAgentsOptions struct {
	ListOptions
}

ListAgentsOptions represents the available ListAgents() options.

GitLab API docs: https://docs.gitlab.com/api/cluster_agents/#list-the-agents-for-a-project

type ListAllSnippetsOptions added in v0.116.0 

type ListAllSnippetsOptions struct {
	ListOptions
	CreatedAfter      *ISOTime `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore     *ISOTime `url:"created_before,omitempty" json:"created_before,omitempty"`
	RepositoryStorage *string  `url:"repository_storage,omitempty" json:"repository_storage,omitempty"`
}

ListAllSnippetsOptions represents the available ListAllSnippets() options.

GitLab API docs: https://docs.gitlab.com/api/snippets/#list-all-snippets

type ListApplicationsOptions added in v0.116.0 

type ListApplicationsOptions struct {
	ListOptions
}

ListApplicationsOptions represents the available ListApplications() options.

type ListAuditEventsOptions added in v0.116.0 

type ListAuditEventsOptions struct {
	ListOptions
	CreatedAfter  *time.Time `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore *time.Time `url:"created_before,omitempty" json:"created_before,omitempty"`
}

ListAuditEventsOptions represents the available ListProjectAuditEvents(), ListGroupAuditEvents() or ListInstanceAuditEvents() options.

GitLab API docs: https://docs.gitlab.com/api/audit_events/

type ListAwardEmojiOptions added in v0.10.6 

type ListAwardEmojiOptions struct {
	ListOptions
}

ListAwardEmojiOptions represents the available options for listing emoji for each resource

GitLab API docs: https://docs.gitlab.com/api/emoji_reactions/

type ListBillableGroupMembersOptions added in v0.116.0 

type ListBillableGroupMembersOptions struct {
	ListOptions
	Search *string `url:"search,omitempty" json:"search,omitempty"`
	Sort   *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListBillableGroupMembersOptions represents the available ListBillableGroupMembers() options.

GitLab API docs: https://docs.gitlab.com/api/members/#list-all-billable-members-of-a-group

type ListBranchesOptions added in v0.6.0 

type ListBranchesOptions struct {
	ListOptions
	Search *string `url:"search,omitempty" json:"search,omitempty"`
	Regex  *string `url:"regex,omitempty" json:"regex,omitempty"`
}

ListBranchesOptions represents the available ListBranches() options.

GitLab API docs: https://docs.gitlab.com/api/branches/#list-repository-branches

type ListBroadcastMessagesOptions added in v0.8.1 

type ListBroadcastMessagesOptions struct {
	ListOptions
}

ListBroadcastMessagesOptions represents the available ListBroadcastMessages() options.

GitLab API docs: https://docs.gitlab.com/api/broadcast_messages/#get-all-broadcast-messages

type ListCIYMLTemplatesOptions added in v0.11.1 

type ListCIYMLTemplatesOptions struct {
	ListOptions
}

ListCIYMLTemplatesOptions represents the available ListAllTemplates() options.

GitLab API docs: https://docs.gitlab.com/api/templates/gitlab_ci_ymls/#list-gitlab-ci-yaml-templates

type ListClientKeysOptions added in v0.116.0 

type ListClientKeysOptions struct {
	ListOptions
}

ListClientKeysOptions represents the available ListClientKeys() options.

GitLab API docs: https://docs.gitlab.com/api/error_tracking/#list-project-client-keys

type ListCommitDiscussionsOptions added in v0.11.2 

type ListCommitDiscussionsOptions struct {
	ListOptions
}

ListCommitDiscussionsOptions represents the available ListCommitDiscussions() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#list-project-commit-discussion-items

type ListCommitsOptions 

type ListCommitsOptions struct {
	ListOptions
	RefName     *string    `url:"ref_name,omitempty" json:"ref_name,omitempty"`
	Since       *time.Time `url:"since,omitempty" json:"since,omitempty"`
	Until       *time.Time `url:"until,omitempty" json:"until,omitempty"`
	Path        *string    `url:"path,omitempty" json:"path,omitempty"`
	Author      *string    `url:"author,omitempty" json:"author,omitempty"`
	All         *bool      `url:"all,omitempty" json:"all,omitempty"`
	WithStats   *bool      `url:"with_stats,omitempty" json:"with_stats,omitempty"`
	FirstParent *bool      `url:"first_parent,omitempty" json:"first_parent,omitempty"`
	Trailers    *bool      `url:"trailers,omitempty" json:"trailers,omitempty"`
}

ListCommitsOptions represents the available ListCommits() options.

GitLab API docs: https://docs.gitlab.com/api/commits/#list-repository-commits

type ListContributionEventsOptions added in v0.8.0 

type ListContributionEventsOptions struct {
	ListOptions
	Action     *EventTypeValue       `url:"action,omitempty" json:"action,omitempty"`
	TargetType *EventTargetTypeValue `url:"target_type,omitempty" json:"target_type,omitempty"`
	Before     *ISOTime              `url:"before,omitempty" json:"before,omitempty"`
	After      *ISOTime              `url:"after,omitempty" json:"after,omitempty"`
	Sort       *string               `url:"sort,omitempty" json:"sort,omitempty"`
	Scope      *string               `url:"scope,omitempty" json:"scope,omitempty"`
}

ListContributionEventsOptions represents the options for GetUserContributionEvents

GitLab API docs: https://docs.gitlab.com/api/events/#get-user-contribution-events

type ListContributorsOptions added in v0.8.1 

type ListContributorsOptions struct {
	ListOptions
	OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort    *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListContributorsOptions represents the available ListContributors() options.

GitLab API docs: https://docs.gitlab.com/api/repositories/#contributors

type ListDescendantGroupsOptions added in v0.116.0 

type ListDescendantGroupsOptions ListGroupsOptions

ListDescendantGroupsOptions represents the available ListDescendantGroups() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-descendant-groups

type ListDockerfileTemplatesOptions added in v0.116.0 

type ListDockerfileTemplatesOptions struct {
	ListOptions
}

ListDockerfileTemplatesOptions represents the available ListAllTemplates() options.

GitLab API docs: https://docs.gitlab.com/api/templates/dockerfiles/#list-dockerfile-templates

type ListDraftNotesOptions added in v0.116.0 

type ListDraftNotesOptions struct {
	ListOptions
	OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort    *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListDraftNotesOptions represents the available ListDraftNotes() options.

GitLab API docs: https://docs.gitlab.com/api/draft_notes/#list-all-merge-request-draft-notes

type ListEmailsForUserOptions added in v0.8.1 

type ListEmailsForUserOptions struct {
	ListOptions
}

ListEmailsForUserOptions represents the available ListEmailsForUser() options.

GitLab API docs: https://docs.gitlab.com/api/user_email_addresses/#list-all-email-addresses-for-a-user

type ListEnterpriseUsersOptions added in v0.128.0 

type ListEnterpriseUsersOptions struct {
	ListOptions
	Username      string     `url:"username,omitempty" json:"username,omitempty"`
	Search        string     `url:"search,omitempty" json:"search,omitempty"`
	Active        bool       `url:"active,omitempty" json:"active,omitempty"`
	Blocked       bool       `url:"blocked,omitempty" json:"blocked,omitempty"`
	CreatedAfter  *time.Time `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore *time.Time `url:"created_before,omitempty" json:"created_before,omitempty"`
	TwoFactor     string     `url:"two_factor,omitempty" json:"two_factor,omitempty"`
}

ListEnterpriseUsersOptions represents the available ListEnterpriseUsers() options.

GitLab API docs: https://docs.gitlab.com/api/group_enterprise_users/#list-all-enterprise-users

type ListEnvironmentsOptions added in v0.7.0 

type ListEnvironmentsOptions struct {
	ListOptions
	Name   *string `url:"name,omitempty" json:"name,omitempty"`
	Search *string `url:"search,omitempty" json:"search,omitempty"`
	States *string `url:"states,omitempty" json:"states,omitempty"`
}

ListEnvironmentsOptions represents the available ListEnvironments() options.

GitLab API docs: https://docs.gitlab.com/api/environments/#list-environments

type ListEpicNotesOptions added in v0.116.0 

type ListEpicNotesOptions struct {
	ListOptions
	OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort    *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListEpicNotesOptions represents the available ListEpicNotes() options. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/notes/#list-all-epic-notes

type ListFeatureFlagUserListsOptions added in v0.128.0 

type ListFeatureFlagUserListsOptions struct {
	ListOptions
	Search string `url:"search,omitempty" json:"search,omitempty"`
}

ListFeatureFlagUserListsOptions represents the available ListFeatureFlagUserLists() options.

GitLab API docs: https://docs.gitlab.com/api/feature_flag_user_lists/#list-all-feature-flag-user-lists-for-a-project

type ListFreezePeriodsOptions added in v0.116.0 

type ListFreezePeriodsOptions struct {
	ListOptions
}

ListFreezePeriodsOptions represents the available ListFreezePeriodsOptions() options.

GitLab API docs: https://docs.gitlab.com/api/freeze_periods/#list-freeze-periods

type ListGeoNodesOptions added in v0.116.0 

type ListGeoNodesOptions struct {
	ListOptions
}

ListGeoNodesOptions represents the available ListGeoNodes() options. Deprecated: will be removed in v5 of the API, use Geo Sites API instead

GitLab API docs: https://docs.gitlab.com/api/geo_nodes/#retrieve-configuration-about-all-geo-nodes

type ListGeoSitesOptions added in v0.128.0 

type ListGeoSitesOptions struct {
	ListOptions
}

ListGeoSitesOptions represents the available ListGeoSites() options.

GitLab API docs: https://docs.gitlab.com/api/geo_sites/#list-all-geo-sites

type ListGroupAccessTokensOptions added in v0.116.0 

type ListGroupAccessTokensOptions struct {
	ListOptions
	CreatedAfter   *ISOTime          `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore  *ISOTime          `url:"created_before,omitempty" json:"created_before,omitempty"`
	LastUsedAfter  *ISOTime          `url:"last_used_after,omitempty" json:"last_used_after,omitempty"`
	LastUsedBefore *ISOTime          `url:"last_used_before,omitempty" json:"last_used_before,omitempty"`
	Revoked        *bool             `url:"revoked,omitempty" json:"revoked,omitempty"`
	Search         *string           `url:"search,omitempty" json:"search,omitempty"`
	State          *AccessTokenState `url:"state,omitempty" json:"state,omitempty"`
	ExpiresAfter   *ISOTime          `url:"expires_after,omitempty" json:"expires_after,omitempty"`
	ExpiresBefore  *ISOTime          `url:"expires_before,omitempty" json:"expires_before,omitempty"`
	Sort           *AccessTokenSort  `url:"sort,omitempty" json:"sort,omitempty"`
}

ListGroupAccessTokensOptions represents the available options for listing access tokens in a group.

GitLab API docs: https://docs.gitlab.com/api/group_access_tokens/#list-all-group-access-tokens

type ListGroupBadgesOptions added in v0.116.0 

type ListGroupBadgesOptions struct {
	ListOptions
	Name *string `url:"name,omitempty" json:"name,omitempty"`
}

ListGroupBadgesOptions represents the available ListGroupBadges() options.

GitLab API docs: https://docs.gitlab.com/api/group_badges/#list-all-badges-of-a-group

type ListGroupDeployTokensOptions added in v0.116.0 

type ListGroupDeployTokensOptions struct {
	ListOptions
}

ListGroupDeployTokensOptions represents the available ListGroupDeployTokens() options.

GitLab API docs: https://docs.gitlab.com/api/deploy_tokens/#list-group-deploy-tokens

type ListGroupEpicBoardsOptions added in v0.116.0 

type ListGroupEpicBoardsOptions struct {
	ListOptions
}

ListGroupEpicBoardsOptions represents the available ListGroupEpicBoards() options.

GitLab API docs: https://docs.gitlab.com/api/group_epic_boards/#list-all-epic-boards-in-a-group

type ListGroupEpicDiscussionsOptions added in v0.11.2 

type ListGroupEpicDiscussionsOptions struct {
	ListOptions
}

ListGroupEpicDiscussionsOptions represents the available ListEpicDiscussions() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#list-group-epic-discussion-items

type ListGroupEpicsOptions added in v0.116.0 

type ListGroupEpicsOptions struct {
	ListOptions
	AuthorID                *int64        `url:"author_id,omitempty" json:"author_id,omitempty"`
	Labels                  *LabelOptions `url:"labels,comma,omitempty" json:"labels,omitempty"`
	WithLabelDetails        *bool         `url:"with_labels_details,omitempty" json:"with_labels_details,omitempty"`
	OrderBy                 *string       `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                    *string       `url:"sort,omitempty" json:"sort,omitempty"`
	Search                  *string       `url:"search,omitempty" json:"search,omitempty"`
	State                   *string       `url:"state,omitempty" json:"state,omitempty"`
	CreatedAfter            *time.Time    `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore           *time.Time    `url:"created_before,omitempty" json:"created_before,omitempty"`
	UpdatedAfter            *time.Time    `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore           *time.Time    `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	IncludeAncestorGroups   *bool         `url:"include_ancestor_groups,omitempty" json:"include_ancestor_groups,omitempty"`
	IncludeDescendantGroups *bool         `url:"include_descendant_groups,omitempty" json:"include_descendant_groups,omitempty"`
	MyReactionEmoji         *string       `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
}

ListGroupEpicsOptions represents the available ListGroupEpics() options. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/epics/#list-epics-for-a-group

type ListGroupHooksOptions added in v0.116.0 

type ListGroupHooksOptions struct {
	ListOptions
}

ListGroupHooksOptions represents the available ListGroupHooks() options.

GitLab API docs: https://docs.gitlab.com/api/group_webhooks/#list-group-hooks

type ListGroupIssueBoardListsOptions added in v0.11.0 

type ListGroupIssueBoardListsOptions struct {
	ListOptions
}

ListGroupIssueBoardListsOptions represents the available ListGroupIssueBoardLists() options.

GitLab API docs: https://docs.gitlab.com/api/group_boards/#list-group-issue-board-lists

type ListGroupIssueBoardsOptions added in v0.11.0 

type ListGroupIssueBoardsOptions struct {
	ListOptions
}

ListGroupIssueBoardsOptions represents the available ListGroupIssueBoards() options.

GitLab API docs: https://docs.gitlab.com/api/group_boards/#list-all-group-issue-boards-in-a-group

type ListGroupIssuesOptions added in v0.6.0 

type ListGroupIssuesOptions struct {
	ListOptions
	State             *string       `url:"state,omitempty" json:"state,omitempty"`
	Labels            *LabelOptions `url:"labels,comma,omitempty" json:"labels,omitempty"`
	NotLabels         *LabelOptions `url:"not[labels],comma,omitempty" json:"not[labels],omitempty"`
	WithLabelDetails  *bool         `url:"with_labels_details,omitempty" json:"with_labels_details,omitempty"`
	IIDs              *[]int64      `url:"iids[],omitempty" json:"iids,omitempty"`
	Milestone         *string       `url:"milestone,omitempty" json:"milestone,omitempty"`
	NotMilestone      *string       `url:"not[milestone],omitempty" json:"not[milestone],omitempty"`
	Scope             *string       `url:"scope,omitempty" json:"scope,omitempty"`
	AuthorID          *int64        `url:"author_id,omitempty" json:"author_id,omitempty"`
	NotAuthorID       *int64        `url:"not[author_id],omitempty" json:"not[author_id],omitempty"`
	AuthorUsername    *string       `url:"author_username,omitempty" json:"author_username,omitempty"`
	NotAuthorUsername *string       `url:"not[author_username],omitempty" json:"not[author_username],omitempty"`

	// AssigneeID is defined as an int64 in the documentation, however, the field
	// must be able to accept Assignee IDs and the words 'None' and 'Any'.  Use
	// *AssigneeIDValue instead of *int64.
	AssigneeID          *AssigneeIDValue `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	NotAssigneeID       *int64           `url:"not[assignee_id],omitempty" json:"not[assignee_id],omitempty"`
	AssigneeUsername    *string          `url:"assignee_username,omitempty" json:"assignee_username,omitempty"`
	NotAssigneeUsername *string          `url:"not[assignee_username],omitempty" json:"not[assignee_username],omitempty"`
	MyReactionEmoji     *string          `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
	NotMyReactionEmoji  *string          `url:"not[my_reaction_emoji],omitempty" json:"not[my_reaction_emoji],omitempty"`
	OrderBy             *string          `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                *string          `url:"sort,omitempty" json:"sort,omitempty"`
	Search              *string          `url:"search,omitempty" json:"search,omitempty"`
	NotSearch           *string          `url:"not[search],omitempty" json:"not[search],omitempty"`
	In                  *string          `url:"in,omitempty" json:"in,omitempty"`
	NotIn               *string          `url:"not[in],omitempty" json:"not[in],omitempty"`
	CreatedAfter        *time.Time       `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore       *time.Time       `url:"created_before,omitempty" json:"created_before,omitempty"`
	DueDate             *string          `url:"due_date,omitempty" json:"due_date,omitempty"`
	UpdatedAfter        *time.Time       `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore       *time.Time       `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	Confidential        *bool            `url:"confidential,omitempty" json:"confidential,omitempty"`
	IssueType           *string          `url:"issue_type,omitempty" json:"issue_type,omitempty"`
	IterationID         *int64           `url:"iteration_id,omitempty" json:"iteration_id,omitempty"`
}

ListGroupIssuesOptions represents the available ListGroupIssues() options.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-group-issues

type ListGroupIterationsOptions added in v0.116.0 

type ListGroupIterationsOptions struct {
	ListOptions
	State            *string `url:"state,omitempty" json:"state,omitempty"`
	Search           *string `url:"search,omitempty" json:"search,omitempty"`
	IncludeAncestors *bool   `url:"include_ancestors,omitempty" json:"include_ancestors,omitempty"`
}

ListGroupIterationsOptions contains the available ListGroupIterations() options

GitLab API docs: https://docs.gitlab.com/api/group_iterations/#list-group-iterations

type ListGroupLabelsOptions added in v0.116.0 

type ListGroupLabelsOptions struct {
	ListOptions
	WithCounts              *bool   `url:"with_counts,omitempty" json:"with_counts,omitempty"`
	IncludeAncestorGroups   *bool   `url:"include_ancestor_groups,omitempty" json:"include_ancestor_groups,omitempty"`
	IncludeDescendantGroups *bool   `url:"include_descendant_groups,omitempty" json:"include_descendant_groups,omitempty"`
	OnlyGroupLabels         *bool   `url:"only_group_labels,omitempty" json:"only_group_labels,omitempty"`
	Search                  *string `url:"search,omitempty" json:"search,omitempty"`
}

ListGroupLabelsOptions represents the available ListGroupLabels() options.

GitLab API docs: https://docs.gitlab.com/api/group_labels/#list-group-labels

type ListGroupMembersOptions added in v0.4.0 

type ListGroupMembersOptions struct {
	ListOptions
	Query        *string  `url:"query,omitempty" json:"query,omitempty"`
	UserIDs      *[]int64 `url:"user_ids[],omitempty" json:"user_ids,omitempty"`
	ShowSeatInfo *bool    `url:"show_seat_info,omitempty" json:"show_seat_info,omitempty"`
}

ListGroupMembersOptions represents the available ListGroupMembers() and ListAllGroupMembers() options.

GitLab API docs: https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project

type ListGroupMergeRequestsOptions added in v0.11.1 

type ListGroupMergeRequestsOptions struct {
	ListOptions
	State                  *string           `url:"state,omitempty" json:"state,omitempty"`
	OrderBy                *string           `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                   *string           `url:"sort,omitempty" json:"sort,omitempty"`
	Milestone              *string           `url:"milestone,omitempty" json:"milestone,omitempty"`
	View                   *string           `url:"view,omitempty" json:"view,omitempty"`
	Labels                 *LabelOptions     `url:"labels,comma,omitempty" json:"labels,omitempty"`
	NotLabels              *LabelOptions     `url:"not[labels],comma,omitempty" json:"not[labels],omitempty"`
	WithLabelsDetails      *bool             `url:"with_labels_details,omitempty" json:"with_labels_details,omitempty"`
	WithMergeStatusRecheck *bool             `url:"with_merge_status_recheck,omitempty" json:"with_merge_status_recheck,omitempty"`
	CreatedAfter           *time.Time        `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore          *time.Time        `url:"created_before,omitempty" json:"created_before,omitempty"`
	UpdatedAfter           *time.Time        `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore          *time.Time        `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	Scope                  *string           `url:"scope,omitempty" json:"scope,omitempty"`
	AuthorID               *int64            `url:"author_id,omitempty" json:"author_id,omitempty"`
	AuthorUsername         *string           `url:"author_username,omitempty" json:"author_username,omitempty"`
	NotAuthorUsername      *string           `url:"not[author_username],omitempty" json:"not[author_username],omitempty"`
	AssigneeID             *AssigneeIDValue  `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	ApproverIDs            *ApproverIDsValue `url:"approver_ids,omitempty" json:"approver_ids,omitempty"`
	ApprovedByIDs          *ApproverIDsValue `url:"approved_by_ids,omitempty" json:"approved_by_ids,omitempty"`
	ReviewerID             *ReviewerIDValue  `url:"reviewer_id,omitempty" json:"reviewer_id,omitempty"`
	ReviewerUsername       *string           `url:"reviewer_username,omitempty" json:"reviewer_username,omitempty"`
	MyReactionEmoji        *string           `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
	SourceBranch           *string           `url:"source_branch,omitempty" json:"source_branch,omitempty"`
	TargetBranch           *string           `url:"target_branch,omitempty" json:"target_branch,omitempty"`
	Search                 *string           `url:"search,omitempty" json:"search,omitempty"`
	In                     *string           `url:"in,omitempty" json:"in,omitempty"`
	Draft                  *bool             `url:"draft,omitempty" json:"draft,omitempty"`
	WIP                    *string           `url:"wip,omitempty" json:"wip,omitempty"`
}

ListGroupMergeRequestsOptions represents the available ListGroupMergeRequests() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-group-merge-requests

type ListGroupMilestonesOptions added in v0.10.0 

type ListGroupMilestonesOptions struct {
	ListOptions
	IIDs               *[]int64 `url:"iids[],omitempty" json:"iids,omitempty"`
	State              *string  `url:"state,omitempty" json:"state,omitempty"`
	Title              *string  `url:"title,omitempty" json:"title,omitempty"`
	Search             *string  `url:"search,omitempty" json:"search,omitempty"`
	SearchTitle        *string  `url:"search_title,omitempty" json:"search_title,omitempty"`
	IncludeAncestors   *bool    `url:"include_ancestors,omitempty" json:"include_ancestors,omitempty"`
	IncludeDescendents *bool    `url:"include_descendents,omitempty" json:"include_descendents,omitempty"`
	UpdatedBefore      *ISOTime `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	UpdatedAfter       *ISOTime `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	ContainingDate     *ISOTime `url:"containing_date,omitempty" json:"containing_date,omitempty"`
	StartDate          *ISOTime `url:"start_date,omitempty" json:"start_date,omitempty"`
	EndDate            *ISOTime `url:"end_date,omitempty" json:"end_date,omitempty"`

	// Deprecated: in GitLab 16.7, use IncludeAncestors instead
	IncludeParentMilestones *bool `url:"include_parent_milestones,omitempty" json:"include_parent_milestones,omitempty"`
}

ListGroupMilestonesOptions represents the available ListGroupMilestones() options.

GitLab API docs: https://docs.gitlab.com/api/group_milestones/#list-group-milestones

type ListGroupPackagesOptions added in v0.116.0 

type ListGroupPackagesOptions struct {
	ListOptions
	ExcludeSubGroups   *bool   `url:"exclude_subgroups,omitempty" json:"exclude_subgroups,omitempty"`
	OrderBy            *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort               *string `url:"sort,omitempty" json:"sort,omitempty"`
	PackageType        *string `url:"package_type,omitempty" json:"package_type,omitempty"`
	PackageName        *string `url:"package_name,omitempty" json:"package_name,omitempty"`
	IncludeVersionless *bool   `url:"include_versionless,omitempty" json:"include_versionless,omitempty"`
	Status             *string `url:"status,omitempty" json:"status,omitempty"`
}

ListGroupPackagesOptions represents the available ListGroupPackages() options.

GitLab API docs: https://docs.gitlab.com/api/packages/#for-a-group

type ListGroupPersonalAccessTokensOptions added in v1.2.0 

type ListGroupPersonalAccessTokensOptions struct {
	ListOptions
	CreatedAfter   *ISOTime `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore  *ISOTime `url:"created_before,omitempty" json:"created_before,omitempty"`
	LastUsedAfter  *ISOTime `url:"last_used_after,omitempty" json:"last_used_after,omitempty"`
	LastUsedBefore *ISOTime `url:"last_used_before,omitempty" json:"last_used_before,omitempty"`
	Revoked        *bool    `url:"revoked,omitempty" json:"revoked,omitempty"`
	Search         *string  `url:"search,omitempty" json:"search,omitempty"`
	State          *string  `url:"state,omitempty" json:"state,omitempty"`
}

ListGroupPersonalAccessTokensOptions represents the available ListGroupPersonalAccessTokens() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-all-personal-access-tokens-for-a-group

type ListGroupProjectsOptions added in v0.4.0 

type ListGroupProjectsOptions struct {
	ListOptions
	Active                   *bool             `url:"active,omitempty" json:"active,omitempty"`
	Archived                 *bool             `url:"archived,omitempty" json:"archived,omitempty"`
	IncludeSubGroups         *bool             `url:"include_subgroups,omitempty" json:"include_subgroups,omitempty"`
	MinAccessLevel           *AccessLevelValue `url:"min_access_level,omitempty" json:"min_access_level,omitempty"`
	OrderBy                  *string           `url:"order_by,omitempty" json:"order_by,omitempty"`
	Owned                    *bool             `url:"owned,omitempty" json:"owned,omitempty"`
	Search                   *string           `url:"search,omitempty" json:"search,omitempty"`
	Simple                   *bool             `url:"simple,omitempty" json:"simple,omitempty"`
	Sort                     *string           `url:"sort,omitempty" json:"sort,omitempty"`
	Starred                  *bool             `url:"starred,omitempty" json:"starred,omitempty"`
	Topic                    *string           `url:"topic,omitempty" json:"topic,omitempty"`
	Visibility               *VisibilityValue  `url:"visibility,omitempty" json:"visibility,omitempty"`
	WithCustomAttributes     *bool             `url:"with_custom_attributes,omitempty" json:"with_custom_attributes,omitempty"`
	WithIssuesEnabled        *bool             `url:"with_issues_enabled,omitempty" json:"with_issues_enabled,omitempty"`
	WithMergeRequestsEnabled *bool             `url:"with_merge_requests_enabled,omitempty" json:"with_merge_requests_enabled,omitempty"`
	WithSecurityReports      *bool             `url:"with_security_reports,omitempty" json:"with_security_reports,omitempty"`
	WithShared               *bool             `url:"with_shared,omitempty" json:"with_shared,omitempty"`
}

ListGroupProjectsOptions represents the available ListGroupProjects() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-projects

type ListGroupProtectedBranchesOptions added in v1.23.0 

type ListGroupProtectedBranchesOptions struct {
	ListOptions
	Search *string `url:"search,omitempty" json:"search,omitempty"`
}

ListGroupProtectedBranchesOptions represents the available ListProtectedBranches() options.

GitLab API docs: https://docs.gitlab.com/api/group_protected_branches/#list-protected-branches

type ListGroupProtectedEnvironmentsOptions added in v0.116.0 

type ListGroupProtectedEnvironmentsOptions struct {
	ListOptions
}

ListGroupProtectedEnvironmentsOptions represents the available ListGroupProtectedEnvironments() options.

GitLab API docs: https://docs.gitlab.com/api/group_protected_environments/#list-group-level-protected-environments

type ListGroupRegistryRepositoriesOptions added in v1.0.0 

type ListGroupRegistryRepositoriesOptions struct {
	ListOptions
}

ListGroupRegistryRepositoriesOptions represents the available ListGroupRegistryRepositories() options.

GitLab API docs: https://docs.gitlab.com/api/container_registry/#within-a-group

type ListGroupRelationsStatusOptions added in v0.155.0 

type ListGroupRelationsStatusOptions struct {
	ListOptions

	Relation *string `url:"relation,omitempty" json:"relation,omitempty"`
}

ListGroupRelationsStatusOptions represents the available ListExportStatus() options.

GitLab API docs: https://docs.gitlab.com/api/group_relations_export/#export-status

type ListGroupReleasesOptions added in v0.124.0 

type ListGroupReleasesOptions struct {
	ListOptions
	Simple *bool `url:"simple,omitempty" json:"simple,omitempty"`
}

ListGroupReleasesOptions represents the available ListGroupReleases() options.

GitLab API docs: https://docs.gitlab.com/api/group_releases.html#list-group-releases

type ListGroupSSHKeysOptions added in v1.3.0 

type ListGroupSSHKeysOptions struct {
	ListOptions
	CreatedAfter  *ISOTime `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore *ISOTime `url:"created_before,omitempty" json:"created_before,omitempty"`
	ExpiresBefore *ISOTime `url:"expires_before,omitempty" json:"expires_before,omitempty"`
	ExpiresAfter  *ISOTime `url:"expires_after,omitempty" json:"expires_after,omitempty"`
}

ListGroupSSHKeysOptions represents the available ListGroupSSHKeys() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-all-ssh-keys-for-a-group

type ListGroupSharedProjectsOptions added in v0.125.0 

type ListGroupSharedProjectsOptions struct {
	ListOptions
	Archived                 *bool             `url:"archived,omitempty" json:"archived,omitempty"`
	MinAccessLevel           *AccessLevelValue `url:"min_access_level,omitempty" json:"min_access_level,omitempty"`
	OrderBy                  *string           `url:"order_by,omitempty" json:"order_by,omitempty"`
	Search                   *string           `url:"search,omitempty" json:"search,omitempty"`
	Simple                   *bool             `url:"simple,omitempty" json:"simple,omitempty"`
	Sort                     *string           `url:"sort,omitempty" json:"sort,omitempty"`
	Starred                  *bool             `url:"starred,omitempty" json:"starred,omitempty"`
	Visibility               *VisibilityValue  `url:"visibility,omitempty" json:"visibility,omitempty"`
	WithCustomAttributes     *bool             `url:"with_custom_attributes,omitempty" json:"with_custom_attributes,omitempty"`
	WithIssuesEnabled        *bool             `url:"with_issues_enabled,omitempty" json:"with_issues_enabled,omitempty"`
	WithMergeRequestsEnabled *bool             `url:"with_merge_requests_enabled,omitempty" json:"with_merge_requests_enabled,omitempty"`
}

ListGroupSharedProjectsOptions represents the available ListGroupSharedProjects() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-shared-projects

type ListGroupVariablesOptions added in v0.116.0 

type ListGroupVariablesOptions struct {
	ListOptions
}

ListGroupVariablesOptions represents the available options for listing variables for a group.

GitLab API docs: https://docs.gitlab.com/api/group_level_variables/#list-group-variables

type ListGroupWikisOptions added in v0.116.0 

type ListGroupWikisOptions struct {
	WithContent *bool `url:"with_content,omitempty" json:"with_content,omitempty"`
}

ListGroupWikisOptions represents the available ListGroupWikis options.

GitLab API docs: https://docs.gitlab.com/api/group_wikis/#list-wiki-pages

type ListGroupsOptions 

type ListGroupsOptions struct {
	ListOptions
	SkipGroups           *[]int64          `url:"skip_groups,omitempty" del:"," json:"skip_groups,omitempty"`
	AllAvailable         *bool             `url:"all_available,omitempty" json:"all_available,omitempty"`
	Search               *string           `url:"search,omitempty" json:"search,omitempty"`
	OrderBy              *string           `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                 *string           `url:"sort,omitempty" json:"sort,omitempty"`
	Statistics           *bool             `url:"statistics,omitempty" json:"statistics,omitempty"`
	Visibility           *VisibilityValue  `url:"visibility,omitempty" json:"visibility,omitempty"`
	WithCustomAttributes *bool             `url:"with_custom_attributes,omitempty" json:"with_custom_attributes,omitempty"`
	Owned                *bool             `url:"owned,omitempty" json:"owned,omitempty"`
	MinAccessLevel       *AccessLevelValue `url:"min_access_level,omitempty" json:"min_access_level,omitempty"`
	TopLevelOnly         *bool             `url:"top_level_only,omitempty" json:"top_level_only,omitempty"`
	RepositoryStorage    *string           `url:"repository_storage,omitempty" json:"repository_storage,omitempty"`
	MarkedForDeletionOn  *ISOTime          `url:"marked_for_deletion_on,omitempty" json:"marked_for_deletion_on,omitempty"`
	Active               *bool             `url:"active,omitempty" json:"active,omitempty"`
	Archived             *bool             `url:"archived,omitempty" json:"archived,omitempty"`
}

ListGroupsOptions represents the available ListGroups() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-groups

type ListGroupsRunnersOptions added in v0.116.0 

type ListGroupsRunnersOptions struct {
	ListOptions
	Type    *string   `url:"type,omitempty" json:"type,omitempty"`
	Status  *string   `url:"status,omitempty" json:"status,omitempty"`
	TagList *[]string `url:"tag_list,comma,omitempty" json:"tag_list,omitempty"`
}

ListGroupsRunnersOptions represents the available ListGroupsRunners() options.

GitLab API docs: https://docs.gitlab.com/api/runners/#list-groups-runners

type ListInstanceDeployKeysOptions added in v0.116.0 

type ListInstanceDeployKeysOptions struct {
	ListOptions
	Public *bool `url:"public,omitempty" json:"public,omitempty"`
}

ListInstanceDeployKeysOptions represents the available ListAllDeployKeys() options.

GitLab API docs: https://docs.gitlab.com/api/deploy_keys/#list-all-deploy-keys

type ListInstanceVariablesOptions added in v0.116.0 

type ListInstanceVariablesOptions struct {
	ListOptions
}

ListInstanceVariablesOptions represents the available options for listing variables for an instance.

GitLab API docs: https://docs.gitlab.com/api/instance_level_ci_variables/#list-all-instance-variables

type ListIssueBoardsOptions added in v0.8.1 

type ListIssueBoardsOptions struct {
	ListOptions
}

ListIssueBoardsOptions represents the available ListIssueBoards() options.

GitLab API docs: https://docs.gitlab.com/api/boards/#list-project-issue-boards

type ListIssueDiscussionsOptions added in v0.11.2 

type ListIssueDiscussionsOptions struct {
	ListOptions
}

ListIssueDiscussionsOptions represents the available ListIssueDiscussions() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#list-project-issue-discussion-items

type ListIssueNotesOptions 

type ListIssueNotesOptions struct {
	ListOptions
	OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort    *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListIssueNotesOptions represents the available ListIssueNotes() options.

GitLab API docs: https://docs.gitlab.com/api/notes/#list-project-issue-notes

type ListIssuesOptions 

type ListIssuesOptions struct {
	ListOptions
	State               *string          `url:"state,omitempty" json:"state,omitempty"`
	Labels              *LabelOptions    `url:"labels,comma,omitempty" json:"labels,omitempty"`
	NotLabels           *LabelOptions    `url:"not[labels],comma,omitempty" json:"not[labels],omitempty"`
	WithLabelDetails    *bool            `url:"with_labels_details,omitempty" json:"with_labels_details,omitempty"`
	Milestone           *string          `url:"milestone,omitempty" json:"milestone,omitempty"`
	NotMilestone        *string          `url:"not[milestone],omitempty" json:"not[milestone],omitempty"`
	Scope               *string          `url:"scope,omitempty" json:"scope,omitempty"`
	AuthorID            *int64           `url:"author_id,omitempty" json:"author_id,omitempty"`
	AuthorUsername      *string          `url:"author_username,omitempty" json:"author_username,omitempty"`
	NotAuthorUsername   *string          `url:"not[author_username],omitempty" json:"not[author_username],omitempty"`
	NotAuthorID         *[]int64         `url:"not[author_id],omitempty" json:"not[author_id],omitempty"`
	AssigneeID          *AssigneeIDValue `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	NotAssigneeID       *[]int64         `url:"not[assignee_id],omitempty" json:"not[assignee_id],omitempty"`
	AssigneeUsername    *string          `url:"assignee_username,omitempty" json:"assignee_username,omitempty"`
	NotAssigneeUsername *string          `url:"not[assignee_username],omitempty" json:"not[assignee_username],omitempty"`
	MyReactionEmoji     *string          `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
	NotMyReactionEmoji  *[]string        `url:"not[my_reaction_emoji],omitempty" json:"not[my_reaction_emoji],omitempty"`
	IIDs                *[]int64         `url:"iids[],omitempty" json:"iids,omitempty"`
	In                  *string          `url:"in,omitempty" json:"in,omitempty"`
	NotIn               *string          `url:"not[in],omitempty" json:"not[in],omitempty"`
	OrderBy             *string          `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                *string          `url:"sort,omitempty" json:"sort,omitempty"`
	Search              *string          `url:"search,omitempty" json:"search,omitempty"`
	NotSearch           *string          `url:"not[search],omitempty" json:"not[search],omitempty"`
	CreatedAfter        *time.Time       `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore       *time.Time       `url:"created_before,omitempty" json:"created_before,omitempty"`
	DueDate             *string          `url:"due_date,omitempty" json:"due_date,omitempty"`
	UpdatedAfter        *time.Time       `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore       *time.Time       `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	Confidential        *bool            `url:"confidential,omitempty" json:"confidential,omitempty"`
	IssueType           *string          `url:"issue_type,omitempty" json:"issue_type,omitempty"`
	IterationID         *int64           `url:"iteration_id,omitempty" json:"iteration_id,omitempty"`
}

ListIssuesOptions represents the available ListIssues() options.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-issues

type ListIterationEventsOptions added in v0.116.0 

type ListIterationEventsOptions struct {
	ListOptions
}

ListIterationEventsOptions represents the options for all resource state events list methods.

GitLab API docs: https://docs.gitlab.com/api/resource_iteration_events/#list-project-issue-iteration-events

type ListJobsOptions added in v0.6.0 

type ListJobsOptions struct {
	ListOptions
	Scope          *[]BuildStateValue `url:"scope[],omitempty" json:"scope,omitempty"`
	IncludeRetried *bool              `url:"include_retried,omitempty" json:"include_retried,omitempty"`
}

ListJobsOptions represents the available ListProjectJobs() options.

GitLab API docs: https://docs.gitlab.com/api/jobs/#list-project-jobs

type ListLabelEventsOptions added in v0.116.0 

type ListLabelEventsOptions struct {
	ListOptions
}

ListLabelEventsOptions represents the options for all resource label events list methods.

GitLab API docs: https://docs.gitlab.com/api/resource_label_events/#list-project-issue-label-events

type ListLabelsOptions added in v0.8.1 

type ListLabelsOptions struct {
	ListOptions
	WithCounts            *bool   `url:"with_counts,omitempty" json:"with_counts,omitempty"`
	IncludeAncestorGroups *bool   `url:"include_ancestor_groups,omitempty" json:"include_ancestor_groups,omitempty"`
	Search                *string `url:"search,omitempty" json:"search,omitempty"`
	Archived              *bool   `url:"archived,omitempty" json:"archived,omitempty"`
}

ListLabelsOptions represents the available ListLabels() options.

GitLab API docs: https://docs.gitlab.com/api/labels/#list-labels

type ListLicenseTemplatesOptions added in v0.11.1 

type ListLicenseTemplatesOptions struct {
	ListOptions
	Popular *bool `url:"popular,omitempty" json:"popular,omitempty"`
}

ListLicenseTemplatesOptions represents the available ListLicenseTemplates() options.

GitLab API docs: https://docs.gitlab.com/api/templates/licenses/#list-license-templates

type ListMarkdownUploadsOptions added in v0.129.0 

type ListMarkdownUploadsOptions struct {
	ListOptions
}

type ListMembershipsForBillableGroupMemberOptions added in v0.116.0 

type ListMembershipsForBillableGroupMemberOptions struct {
	ListOptions
}

ListMembershipsForBillableGroupMemberOptions represents the available ListMembershipsForBillableGroupMember() options.

GitLab API docs: https://docs.gitlab.com/api/members/#list-memberships-for-a-billable-member-of-a-group

type ListMergeRequestDiffsOptions added in v0.116.0 

type ListMergeRequestDiffsOptions struct {
	ListOptions
	Unidiff *bool `url:"unidiff,omitempty" json:"unidiff,omitempty"`
}

ListMergeRequestDiffsOptions represents the available ListMergeRequestDiffs() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-merge-request-diffs

type ListMergeRequestDiscussionsOptions added in v0.11.2 

type ListMergeRequestDiscussionsOptions struct {
	ListOptions
}

ListMergeRequestDiscussionsOptions represents the available ListMergeRequestDiscussions() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#list-project-merge-request-discussion-items

type ListMergeRequestNotesOptions added in v0.8.1 

type ListMergeRequestNotesOptions struct {
	ListOptions
	OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort    *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListMergeRequestNotesOptions represents the available ListMergeRequestNotes() options.

GitLab API docs: https://docs.gitlab.com/api/notes/#list-all-merge-request-notes

type ListMergeRequestsClosingIssueOptions added in v0.10.6 

type ListMergeRequestsClosingIssueOptions struct {
	ListOptions
}

ListMergeRequestsClosingIssueOptions represents the available ListMergeRequestsClosingIssue() options.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-merge-requests-that-close-a-particular-issue-on-merge

type ListMergeRequestsOptions 

type ListMergeRequestsOptions struct {
	ListOptions
	Approved               *string           `url:"approved,omitempty" json:"approved,omitempty"`
	State                  *string           `url:"state,omitempty" json:"state,omitempty"`
	OrderBy                *string           `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                   *string           `url:"sort,omitempty" json:"sort,omitempty"`
	Milestone              *string           `url:"milestone,omitempty" json:"milestone,omitempty"`
	View                   *string           `url:"view,omitempty" json:"view,omitempty"`
	Labels                 *LabelOptions     `url:"labels,comma,omitempty" json:"labels,omitempty"`
	NotLabels              *LabelOptions     `url:"not[labels],comma,omitempty" json:"not[labels],omitempty"`
	WithLabelsDetails      *bool             `url:"with_labels_details,omitempty" json:"with_labels_details,omitempty"`
	WithMergeStatusRecheck *bool             `url:"with_merge_status_recheck,omitempty" json:"with_merge_status_recheck,omitempty"`
	CreatedAfter           *time.Time        `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore          *time.Time        `url:"created_before,omitempty" json:"created_before,omitempty"`
	UpdatedAfter           *time.Time        `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore          *time.Time        `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	Scope                  *string           `url:"scope,omitempty" json:"scope,omitempty"`
	AuthorID               *int64            `url:"author_id,omitempty" json:"author_id,omitempty"`
	AuthorUsername         *string           `url:"author_username,omitempty" json:"author_username,omitempty"`
	NotAuthorUsername      *string           `url:"not[author_username],omitempty" json:"not[author_username],omitempty"`
	AssigneeID             *AssigneeIDValue  `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	ApproverIDs            *ApproverIDsValue `url:"approver_ids,omitempty" json:"approver_ids,omitempty"`
	ApprovedByIDs          *ApproverIDsValue `url:"approved_by_ids,omitempty" json:"approved_by_ids,omitempty"`
	ReviewerID             *ReviewerIDValue  `url:"reviewer_id,omitempty" json:"reviewer_id,omitempty"`
	ReviewerUsername       *string           `url:"reviewer_username,omitempty" json:"reviewer_username,omitempty"`
	MyReactionEmoji        *string           `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
	SourceBranch           *string           `url:"source_branch,omitempty" json:"source_branch,omitempty"`
	TargetBranch           *string           `url:"target_branch,omitempty" json:"target_branch,omitempty"`
	Search                 *string           `url:"search,omitempty" json:"search,omitempty"`
	In                     *string           `url:"in,omitempty" json:"in,omitempty"`
	Draft                  *bool             `url:"draft,omitempty" json:"draft,omitempty"`
	WIP                    *string           `url:"wip,omitempty" json:"wip,omitempty"`
}

ListMergeRequestsOptions represents the available ListMergeRequests() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-merge-requests

type ListMergeRequestsRelatedToIssueOptions added in v0.116.0 

type ListMergeRequestsRelatedToIssueOptions struct {
	ListOptions
}

ListMergeRequestsRelatedToIssueOptions represents the available ListMergeRequestsRelatedToIssue() options.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-merge-requests-related-to-issue

type ListMergeTrainsOptions added in v0.116.0 

type ListMergeTrainsOptions struct {
	ListOptions
	Scope *string `url:"scope,omitempty" json:"scope,omitempty"`
	Sort  *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListMergeTrainsOptions represents the available ListMergeTrain() options.

GitLab API docs: https://docs.gitlab.com/api/merge_trains/#list-merge-trains-for-a-project

type ListMetricImagesOptions added in v0.128.0 

type ListMetricImagesOptions struct {
	ListOptions
}

ListMetricImagesOptions represents the available ListMetricImages() options.

GitLab API docs: https://docs.gitlab.com/api/alert_management_alerts/#list-metric-images

type ListMilestoneEventsOptions added in v0.116.0 

type ListMilestoneEventsOptions struct {
	ListOptions
}

ListMilestoneEventsOptions represents the options for all resource state events list methods.

GitLab API docs: https://docs.gitlab.com/api/resource_milestone_events/#list-project-issue-milestone-events

type ListMilestonesOptions 

type ListMilestonesOptions struct {
	ListOptions
	IIDs             *[]int64 `url:"iids[],omitempty" json:"iids,omitempty"`
	Title            *string  `url:"title,omitempty" json:"title,omitempty"`
	State            *string  `url:"state,omitempty" json:"state,omitempty"`
	Search           *string  `url:"search,omitempty" json:"search,omitempty"`
	IncludeAncestors *bool    `url:"include_ancestors,omitempty" json:"include_ancestors,omitempty"`

	// Deprecated: in GitLab 16,7, use IncludeAncestors instead
	IncludeParentMilestones *bool `url:"include_parent_milestones,omitempty" json:"include_parent_milestones,omitempty"`
}

ListMilestonesOptions represents the available ListMilestones() options.

GitLab API docs: https://docs.gitlab.com/api/milestones/#list-project-milestones

type ListNamespacesOptions 

type ListNamespacesOptions struct {
	ListOptions
	Search       *string `url:"search,omitempty" json:"search,omitempty"`
	OwnedOnly    *bool   `url:"owned_only,omitempty" json:"owned_only,omitempty"`
	TopLevelOnly *bool   `url:"top_level_only,omitempty" json:"top_level_only,omitempty"`
}

ListNamespacesOptions represents the available ListNamespaces() options.

GitLab API docs: https://docs.gitlab.com/api/namespaces/#list-all-namespaces

type ListOptions 

type ListOptions struct {
	// For keyset-based paginated result sets, the value must be `"keyset"`
	Pagination string `url:"pagination,omitempty" json:"pagination,omitempty"`
	// For offset-based and keyset-based paginated result sets, the number of results to include per page.
	PerPage int64 `url:"per_page,omitempty" json:"per_page,omitempty"`
	// For offset-based paginated result sets, page of results to retrieve.
	Page int64 `url:"page,omitempty" json:"page,omitempty"`
	// For keyset-based paginated result sets, tree record ID at which to fetch the next page.
	PageToken string `url:"page_token,omitempty" json:"page_token,omitempty"`
	// For keyset-based paginated result sets, name of the column by which to order
	OrderBy string `url:"order_by,omitempty" json:"order_by,omitempty"`
	// For keyset-based paginated result sets, sort order (`"asc"“ or `"desc"`)
	Sort string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListOptions specifies the optional parameters to various List methods that support pagination.

type ListPackageFilesOptions added in v0.116.0 

type ListPackageFilesOptions struct {
	ListOptions
}

ListPackageFilesOptions represents the available ListPackageFiles() options.

GitLab API docs: https://docs.gitlab.com/api/packages/#list-package-files

type ListPackageProtectionRulesOptions added in v0.154.0 

type ListPackageProtectionRulesOptions struct {
	ListOptions
}

ListPackageProtectionRulesOptions represents the available ListPackageProtectionRules() options.

GitLab API docs: https://docs.gitlab.com/api/project_packages_protection_rules/#list-package-protection-rules

type ListPagesDomainsOptions added in v0.8.0 

type ListPagesDomainsOptions struct {
	ListOptions
}

ListPagesDomainsOptions represents the available ListPagesDomains() options.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/#list-pages-domains

type ListPendingInvitationsOptions added in v0.116.0 

type ListPendingInvitationsOptions struct {
	ListOptions
	Query *string `url:"query,omitempty" json:"query,omitempty"`
}

ListPendingInvitationsOptions represents the available ListPendingInvitations() options.

GitLab API docs: https://docs.gitlab.com/api/invitations/#list-all-invitations-pending-for-a-group-or-project

type ListPersonalAccessTokensOptions added in v0.116.0 

type ListPersonalAccessTokensOptions struct {
	ListOptions
	CreatedAfter   *ISOTime `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore  *ISOTime `url:"created_before,omitempty" json:"created_before,omitempty"`
	ExpiresAfter   *ISOTime `url:"expires_after,omitempty" json:"expires_after,omitempty"`
	ExpiresBefore  *ISOTime `url:"expires_before,omitempty" json:"expires_before,omitempty"`
	LastUsedAfter  *ISOTime `url:"last_used_after,omitempty" json:"last_used_after,omitempty"`
	LastUsedBefore *ISOTime `url:"last_used_before,omitempty" json:"last_used_before,omitempty"`
	Revoked        *bool    `url:"revoked,omitempty" json:"revoked,omitempty"`
	Search         *string  `url:"search,omitempty" json:"search,omitempty"`
	Sort           *string  `url:"sort,omitempty" json:"sort,omitempty"`
	State          *string  `url:"state,omitempty" json:"state,omitempty"`
	UserID         *int64   `url:"user_id,omitempty" json:"user_id,omitempty"`
}

ListPersonalAccessTokensOptions represents the available ListPersonalAccessTokens() options.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/#list-all-personal-access-tokens

type ListPipelineSchedulesOptions added in v0.9.0 

type ListPipelineSchedulesOptions struct {
	ListOptions
	Scope *PipelineScheduleScopeValue `url:"scope,omitempty"`
}

ListPipelineSchedulesOptions represents the available ListPipelineTriggers() options.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#get-all-pipeline-schedules

type ListPipelineTriggersOptions added in v0.6.0 

type ListPipelineTriggersOptions struct {
	ListOptions
}

ListPipelineTriggersOptions represents the available ListPipelineTriggers() options.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/#list-project-trigger-tokens

type ListPipelinesTriggeredByScheduleOptions added in v0.116.0 

type ListPipelinesTriggeredByScheduleOptions struct {
	ListOptions
}

ListPipelinesTriggeredByScheduleOptions represents the available ListPipelinesTriggeredBySchedule() options.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#get-all-pipelines-triggered-by-a-pipeline-schedule

type ListProjectAccessTokensOptions added in v0.116.0 

type ListProjectAccessTokensOptions struct {
	ListOptions
	State *string `url:"state,omitempty" json:"state,omitempty"`
}

ListProjectAccessTokensOptions represents the available ListProjectAccessTokens() options.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/#list-all-project-access-tokens

type ListProjectBadgesOptions added in v0.11.1 

type ListProjectBadgesOptions struct {
	ListOptions
	Name *string `url:"name,omitempty" json:"name,omitempty"`
}

ListProjectBadgesOptions represents the available ListProjectBadges() options.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#list-all-badges-of-a-project

type ListProjectDependenciesOptions added in v0.128.0 

type ListProjectDependenciesOptions struct {
	ListOptions
	PackageManager []*DependencyPackageManagerValue `url:"package_manager,comma,omitempty" json:"package_manager,omitempty"`
}

ListProjectDependenciesOptions represents the options for listing project dependencies.

GitLab API docs: https://docs.gitlab.com/api/dependencies/#list-project-dependencies

type ListProjectDeployKeysOptions added in v0.8.1 

type ListProjectDeployKeysOptions struct {
	ListOptions
}

ListProjectDeployKeysOptions represents the available ListProjectDeployKeys() options.

GitLab API docs: https://docs.gitlab.com/api/deploy_keys/#list-deploy-keys-for-project

type ListProjectDeployTokensOptions added in v0.116.0 

type ListProjectDeployTokensOptions struct {
	ListOptions
}

ListProjectDeployTokensOptions represents the available ListProjectDeployTokens() options.

GitLab API docs: https://docs.gitlab.com/api/deploy_tokens/#list-project-deploy-tokens

type ListProjectDeploymentsOptions added in v0.8.1 

type ListProjectDeploymentsOptions struct {
	ListOptions
	OrderBy     *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort        *string `url:"sort,omitempty" json:"sort,omitempty"`
	Environment *string `url:"environment,omitempty" json:"environment,omitempty"`
	Status      *string `url:"status,omitempty" json:"status,omitempty"`

	// Only for GitLab versions less than 14
	UpdatedAfter  *time.Time `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore *time.Time `url:"updated_before,omitempty" json:"updated_before,omitempty"`

	// Only for GitLab 14 or higher
	FinishedAfter  *time.Time `url:"finished_after,omitempty" json:"finished_after,omitempty"`
	FinishedBefore *time.Time `url:"finished_before,omitempty" json:"finished_before,omitempty"`
}

ListProjectDeploymentsOptions represents the available ListProjectDeployments() options.

GitLab API docs: https://docs.gitlab.com/api/deployments/#list-project-deployments

type ListProjectExternalStatusChecksOptions added in v0.138.0 

type ListProjectExternalStatusChecksOptions struct {
	ListOptions
}

ListProjectExternalStatusChecksOptions represents the available ListProjectExternalStatusChecks() options.

GitLab API docs: https://docs.gitlab.com/api/status_checks/#get-project-external-status-check-services

type ListProjectFeatureFlagOptions added in v0.116.0 

type ListProjectFeatureFlagOptions struct {
	ListOptions
	Scope *string `url:"scope,omitempty" json:"scope,omitempty"`
}

ListProjectFeatureFlagOptions contains the options for ListProjectFeatureFlags

GitLab API docs: https://docs.gitlab.com/api/feature_flags/#list-feature-flags-for-a-project

type ListProjectGroupOptions added in v0.116.0 

type ListProjectGroupOptions struct {
	ListOptions
	Search               *string           `url:"search,omitempty" json:"search,omitempty"`
	SharedMinAccessLevel *AccessLevelValue `url:"shared_min_access_level,omitempty" json:"shared_min_access_level,omitempty"`
	SharedVisibleOnly    *bool             `url:"shared_visible_only,omitempty" json:"shared_visible_only,omitempty"`
	SkipGroups           *[]int64          `url:"skip_groups,omitempty" json:"skip_groups,omitempty"`
	WithShared           *bool             `url:"with_shared,omitempty" json:"with_shared,omitempty"`
}

ListProjectGroupOptions represents the available ListProjectsGroups() options.

GitLab API docs: https://docs.gitlab.com/api/projects/#list-groups

type ListProjectHooksOptions 

type ListProjectHooksOptions struct {
	ListOptions
}

ListProjectHooksOptions represents the available ListProjectHooks() options.

GitLab API docs: https://docs.gitlab.com/api/project_webhooks/#list-webhooks-for-a-project

type ListProjectInvitedGroupOptions added in v0.138.0 

type ListProjectInvitedGroupOptions struct {
	ListOptions
	Search               *string           `url:"search,omitempty" json:"search,omitempty"`
	MinAccessLevel       *AccessLevelValue `url:"min_access_level,omitempty" json:"min_access_level,omitempty"`
	Relation             *[]string         `url:"relation,omitempty" json:"relation,omitempty"`
	WithCustomAttributes *bool             `url:"with_custom_attributes,omitempty" json:"with_custom_attributes,omitempty"`
}

ListProjectInvitedGroupOptions represents the available ListProjectsInvitedGroups() options.

GitLab API docs: https://docs.gitlab.com/api/projects/#list-a-projects-invited-groups

type ListProjectIssuesOptions 

type ListProjectIssuesOptions struct {
	ListOptions
	IIDs              *[]int64      `url:"iids[],omitempty" json:"iids,omitempty"`
	State             *string       `url:"state,omitempty" json:"state,omitempty"`
	Labels            *LabelOptions `url:"labels,comma,omitempty" json:"labels,omitempty"`
	NotLabels         *LabelOptions `url:"not[labels],comma,omitempty" json:"not[labels],omitempty"`
	WithLabelDetails  *bool         `url:"with_labels_details,omitempty" json:"with_labels_details,omitempty"`
	Milestone         *string       `url:"milestone,omitempty" json:"milestone,omitempty"`
	NotMilestone      *string       `url:"not[milestone],omitempty" json:"not[milestone],omitempty"`
	Scope             *string       `url:"scope,omitempty" json:"scope,omitempty"`
	AuthorID          *int64        `url:"author_id,omitempty" json:"author_id,omitempty"`
	AuthorUsername    *string       `url:"author_username,omitempty" json:"author_username,omitempty"`
	NotAuthorUsername *string       `url:"not[author_username],omitempty" json:"not[author_username],omitempty"`
	NotAuthorID       *int64        `url:"not[author_id],omitempty" json:"not[author_id],omitempty"`

	// AssigneeID is defined as an int in the documentation, however, the field
	// must be able to accept Assignee IDs and the words 'None' and 'Any'.  Use
	// *AssigneeIDValue instead of *int.
	AssigneeID          *AssigneeIDValue `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	NotAssigneeID       *int64           `url:"not[assignee_id],omitempty" json:"not[assignee_id],omitempty"`
	AssigneeUsername    *string          `url:"assignee_username,omitempty" json:"assignee_username,omitempty"`
	NotAssigneeUsername *string          `url:"not[assignee_username],omitempty" json:"not[assignee_username],omitempty"`
	MyReactionEmoji     *string          `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
	NotMyReactionEmoji  *string          `url:"not[my_reaction_emoji],omitempty" json:"not[my_reaction_emoji],omitempty"`
	OrderBy             *string          `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                *string          `url:"sort,omitempty" json:"sort,omitempty"`
	Search              *string          `url:"search,omitempty" json:"search,omitempty"`
	In                  *string          `url:"in,omitempty" json:"in,omitempty"`
	NotIn               *string          `url:"not[in],omitempty" json:"not[in],omitempty"`
	CreatedAfter        *time.Time       `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore       *time.Time       `url:"created_before,omitempty" json:"created_before,omitempty"`
	DueDate             *string          `url:"due_date,omitempty" json:"due_date,omitempty"`
	UpdatedAfter        *time.Time       `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore       *time.Time       `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	Confidential        *bool            `url:"confidential,omitempty" json:"confidential,omitempty"`
	IssueType           *string          `url:"issue_type,omitempty" json:"issue_type,omitempty"`
	IterationID         *int64           `url:"iteration_id,omitempty" json:"iteration_id,omitempty"`
}

ListProjectIssuesOptions represents the available ListProjectIssues() options.

GitLab API docs: https://docs.gitlab.com/api/issues/#list-project-issues

type ListProjectIterationsOptions added in v0.116.0 

type ListProjectIterationsOptions struct {
	ListOptions
	State            *string `url:"state,omitempty" json:"state,omitempty"`
	Search           *string `url:"search,omitempty" json:"search,omitempty"`
	IncludeAncestors *bool   `url:"include_ancestors,omitempty" json:"include_ancestors,omitempty"`
}

ListProjectIterationsOptions contains the available ListProjectIterations() options

GitLab API docs: https://docs.gitlab.com/api/iterations/#list-project-iterations

type ListProjectMembersOptions 

type ListProjectMembersOptions struct {
	ListOptions
	Query        *string  `url:"query,omitempty" json:"query,omitempty"`
	UserIDs      *[]int64 `url:"user_ids[],omitempty" json:"user_ids,omitempty"`
	ShowSeatInfo *bool    `url:"show_seat_info,omitempty" json:"show_seat_info,omitempty"`
}

ListProjectMembersOptions represents the available ListProjectMembers() and ListAllProjectMembers() options.

GitLab API docs: https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project

type ListProjectMergeRequestExternalStatusChecksOptions added in v0.138.0 

type ListProjectMergeRequestExternalStatusChecksOptions struct {
	ListOptions
}

ListProjectMergeRequestExternalStatusChecksOptions represents the available ListProjectMergeRequestExternalStatusChecks() options.

GitLab API docs: https://docs.gitlab.com/api/status_checks/#list-status-checks-for-a-merge-request

type ListProjectMergeRequestsOptions added in v0.6.2 

type ListProjectMergeRequestsOptions struct {
	ListOptions
	IIDs                   *[]int64          `url:"iids[],omitempty" json:"iids,omitempty"`
	State                  *string           `url:"state,omitempty" json:"state,omitempty"`
	OrderBy                *string           `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                   *string           `url:"sort,omitempty" json:"sort,omitempty"`
	Milestone              *string           `url:"milestone,omitempty" json:"milestone,omitempty"`
	View                   *string           `url:"view,omitempty" json:"view,omitempty"`
	Environment            *string           `url:"environment,omitempty" json:"environment,omitempty"`
	Labels                 *LabelOptions     `url:"labels,comma,omitempty" json:"labels,omitempty"`
	NotLabels              *LabelOptions     `url:"not[labels],comma,omitempty" json:"not[labels],omitempty"`
	WithLabelsDetails      *bool             `url:"with_labels_details,omitempty" json:"with_labels_details,omitempty"`
	WithMergeStatusRecheck *bool             `url:"with_merge_status_recheck,omitempty" json:"with_merge_status_recheck,omitempty"`
	CreatedAfter           *time.Time        `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore          *time.Time        `url:"created_before,omitempty" json:"created_before,omitempty"`
	UpdatedAfter           *time.Time        `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore          *time.Time        `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	DeployedBefore         *time.Time        `url:"deployed_before,omitempty" json:"deployed_before,omitempty"`
	DeployedAfter          *time.Time        `url:"deployed_after,omitempty" json:"deployed_after,omitempty"`
	Scope                  *string           `url:"scope,omitempty" json:"scope,omitempty"`
	AuthorID               *int64            `url:"author_id,omitempty" json:"author_id,omitempty"`
	AuthorUsername         *string           `url:"author_username,omitempty" json:"author_username,omitempty"`
	NotAuthorUsername      *string           `url:"not[author_username],omitempty" json:"not[author_username],omitempty"`
	AssigneeID             *AssigneeIDValue  `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
	ApproverIDs            *ApproverIDsValue `url:"approver_ids,omitempty" json:"approver_ids,omitempty"`
	ApprovedByIDs          *ApproverIDsValue `url:"approved_by_ids,omitempty" json:"approved_by_ids,omitempty"`
	ReviewerID             *ReviewerIDValue  `url:"reviewer_id,omitempty" json:"reviewer_id,omitempty"`
	ReviewerUsername       *string           `url:"reviewer_username,omitempty" json:"reviewer_username,omitempty"`
	MyReactionEmoji        *string           `url:"my_reaction_emoji,omitempty" json:"my_reaction_emoji,omitempty"`
	SourceBranch           *string           `url:"source_branch,omitempty" json:"source_branch,omitempty"`
	TargetBranch           *string           `url:"target_branch,omitempty" json:"target_branch,omitempty"`
	Search                 *string           `url:"search,omitempty" json:"search,omitempty"`
	Draft                  *bool             `url:"draft,omitempty" json:"draft,omitempty"`
	WIP                    *string           `url:"wip,omitempty" json:"wip,omitempty"`
}

ListProjectMergeRequestsOptions represents the available ListMergeRequests() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-project-merge-requests

type ListProjectMirrorOptions added in v0.116.0 

type ListProjectMirrorOptions struct {
	ListOptions
}

ListProjectMirrorOptions represents the available ListProjectMirror() options.

type ListProjectPackagesOptions added in v0.116.0 

type ListProjectPackagesOptions struct {
	ListOptions
	OrderBy            *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort               *string `url:"sort,omitempty" json:"sort,omitempty"`
	PackageType        *string `url:"package_type,omitempty" json:"package_type,omitempty"`
	PackageName        *string `url:"package_name,omitempty" json:"package_name,omitempty"`
	PackageVersion     *string `url:"package_version,omitempty" json:"package_version,omitempty"`
	IncludeVersionless *bool   `url:"include_versionless,omitempty" json:"include_versionless,omitempty"`
	Status             *string `url:"status,omitempty" json:"status,omitempty"`
}

ListProjectPackagesOptions represents the available ListProjectPackages() options.

GitLab API docs: https://docs.gitlab.com/api/packages/#for-a-project

type ListProjectPipelinesOptions added in v0.8.0 

type ListProjectPipelinesOptions struct {
	ListOptions
	Scope         *string          `url:"scope,omitempty" json:"scope,omitempty"`
	Status        *BuildStateValue `url:"status,omitempty" json:"status,omitempty"`
	Source        *string          `url:"source,omitempty" json:"source,omitempty"`
	Ref           *string          `url:"ref,omitempty" json:"ref,omitempty"`
	SHA           *string          `url:"sha,omitempty" json:"sha,omitempty"`
	YamlErrors    *bool            `url:"yaml_errors,omitempty" json:"yaml_errors,omitempty"`
	Name          *string          `url:"name,omitempty" json:"name,omitempty"`
	Username      *string          `url:"username,omitempty" json:"username,omitempty"`
	UpdatedAfter  *time.Time       `url:"updated_after,omitempty" json:"updated_after,omitempty"`
	UpdatedBefore *time.Time       `url:"updated_before,omitempty" json:"updated_before,omitempty"`
	OrderBy       *string          `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort          *string          `url:"sort,omitempty" json:"sort,omitempty"`
	CreatedAfter  *time.Time       `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore *time.Time       `url:"created_before,omitempty" json:"created_before,omitempty"`
}

ListProjectPipelinesOptions represents the available ListProjectPipelines() options.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#list-project-pipelines

type ListProjectRegistryRepositoriesOptions added in v1.0.0 

type ListProjectRegistryRepositoriesOptions struct {
	ListOptions

	Tags      *bool `url:"tags,omitempty" json:"tags,omitempty"`
	TagsCount *bool `url:"tags_count,omitempty" json:"tags_count,omitempty"`
}

ListProjectRegistryRepositoriesOptions represents the available ListProjectRegistryRepositories() options.

GitLab API docs: https://docs.gitlab.com/api/container_registry/#list-registry-repositories

type ListProjectRunnersOptions added in v0.7.5 

type ListProjectRunnersOptions ListRunnersOptions

ListProjectRunnersOptions represents the available ListProjectRunners() options.

GitLab API docs: https://docs.gitlab.com/api/runners/#list-projects-runners

type ListProjectSecureFilesOptions added in v0.124.0 

type ListProjectSecureFilesOptions struct {
	ListOptions
}

ListProjectSecureFilesOptions represents the available ListProjectSecureFiles() options.

GitLab API docs: https://docs.gitlab.com/api/secure_files/#list-project-secure-files

type ListProjectSnippetsOptions added in v0.7.2 

type ListProjectSnippetsOptions struct {
	ListOptions
}

ListProjectSnippetsOptions represents the available ListSnippets() options.

GitLab API docs: https://docs.gitlab.com/api/project_snippets/#list-snippets

type ListProjectStarrersOptions added in v0.152.0 

type ListProjectStarrersOptions struct {
	ListOptions
	Search *string `url:"search,omitempty" json:"search,omitempty"`
}

ListProjectStarrersOptions represents the available ListProjectStarrers() options.

GitLab API docs: https://docs.gitlab.com/api/project_starring/#list-users-who-starred-a-project

type ListProjectTemplatesOptions added in v0.116.0 

type ListProjectTemplatesOptions struct {
	ListOptions
	ID   *int64  `url:"id,omitempty" json:"id,omitempty"`
	Type *string `url:"type,omitempty" json:"type,omitempty"`
}

ListProjectTemplatesOptions represents the available ListSnippets() options.

GitLab API docs: https://docs.gitlab.com/api/project_templates/#get-all-templates-of-a-particular-type

type ListProjectUserOptions added in v0.8.0 

type ListProjectUserOptions struct {
	ListOptions
	Search *string `url:"search,omitempty" json:"search,omitempty"`
}

ListProjectUserOptions represents the available ListProjectsUsers() options.

GitLab API docs: https://docs.gitlab.com/api/projects/#list-users

type ListProjectVariablesOptions added in v0.116.0 

type ListProjectVariablesOptions struct {
	ListOptions
}

ListProjectVariablesOptions represents the available options for listing variables in a project.

GitLab API docs: https://docs.gitlab.com/api/project_level_variables/#list-project-variables

type ListProjectVisibleEventsOptions added in v0.116.0 

type ListProjectVisibleEventsOptions struct {
	ListOptions
	Action     *EventTypeValue       `url:"action,omitempty" json:"action,omitempty"`
	TargetType *EventTargetTypeValue `url:"target_type,omitempty" json:"target_type,omitempty"`
	Before     *ISOTime              `url:"before,omitempty" json:"before,omitempty"`
	After      *ISOTime              `url:"after,omitempty" json:"after,omitempty"`
	Sort       *string               `url:"sort,omitempty" json:"sort,omitempty"`
}

ListProjectVisibleEventsOptions represents the available ListProjectVisibleEvents() options.

GitLab API docs: https://docs.gitlab.com/api/events/#list-all-visible-events-for-a-project

type ListProjectVulnerabilitiesOptions added in v0.116.0 

type ListProjectVulnerabilitiesOptions struct {
	ListOptions
}

ListProjectVulnerabilitiesOptions represents the available ListProjectVulnerabilities() options. Deprecated: use GraphQL Query.vulnerabilities instead

GitLab API docs: https://docs.gitlab.com/api/project_vulnerabilities/#list-project-vulnerabilities

type ListProjectsOptions 

type ListProjectsOptions struct {
	ListOptions
	Active                   *bool             `url:"active,omitempty" json:"active,omitempty"`
	Archived                 *bool             `url:"archived,omitempty" json:"archived,omitempty"`
	IDAfter                  *int64            `url:"id_after,omitempty" json:"id_after,omitempty"`
	IDBefore                 *int64            `url:"id_before,omitempty" json:"id_before,omitempty"`
	Imported                 *bool             `url:"imported,omitempty" json:"imported,omitempty"`
	IncludeHidden            *bool             `url:"include_hidden,omitempty" json:"include_hidden,omitempty"`
	IncludePendingDelete     *bool             `url:"include_pending_delete,omitempty" json:"include_pending_delete,omitempty"`
	LastActivityAfter        *time.Time        `url:"last_activity_after,omitempty" json:"last_activity_after,omitempty"`
	LastActivityBefore       *time.Time        `url:"last_activity_before,omitempty" json:"last_activity_before,omitempty"`
	Membership               *bool             `url:"membership,omitempty" json:"membership,omitempty"`
	MinAccessLevel           *AccessLevelValue `url:"min_access_level,omitempty" json:"min_access_level,omitempty"`
	OrderBy                  *string           `url:"order_by,omitempty" json:"order_by,omitempty"`
	Owned                    *bool             `url:"owned,omitempty" json:"owned,omitempty"`
	RepositoryChecksumFailed *bool             `url:"repository_checksum_failed,omitempty" json:"repository_checksum_failed,omitempty"`
	RepositoryStorage        *string           `url:"repository_storage,omitempty" json:"repository_storage,omitempty"`
	Search                   *string           `url:"search,omitempty" json:"search,omitempty"`
	SearchNamespaces         *bool             `url:"search_namespaces,omitempty" json:"search_namespaces,omitempty"`
	Simple                   *bool             `url:"simple,omitempty" json:"simple,omitempty"`
	Sort                     *string           `url:"sort,omitempty" json:"sort,omitempty"`
	Starred                  *bool             `url:"starred,omitempty" json:"starred,omitempty"`
	Statistics               *bool             `url:"statistics,omitempty" json:"statistics,omitempty"`
	Topic                    *string           `url:"topic,omitempty" json:"topic,omitempty"`
	Visibility               *VisibilityValue  `url:"visibility,omitempty" json:"visibility,omitempty"`
	WikiChecksumFailed       *bool             `url:"wiki_checksum_failed,omitempty" json:"wiki_checksum_failed,omitempty"`
	WithCustomAttributes     *bool             `url:"with_custom_attributes,omitempty" json:"with_custom_attributes,omitempty"`
	WithIssuesEnabled        *bool             `url:"with_issues_enabled,omitempty" json:"with_issues_enabled,omitempty"`
	WithMergeRequestsEnabled *bool             `url:"with_merge_requests_enabled,omitempty" json:"with_merge_requests_enabled,omitempty"`
	WithProgrammingLanguage  *string           `url:"with_programming_language,omitempty" json:"with_programming_language,omitempty"`
}

ListProjectsOptions represents the available ListProjects() options.

GitLab API docs: https://docs.gitlab.com/api/projects/#list-all-projects

type ListProtectedBranchesOptions added in v0.8.1 

type ListProtectedBranchesOptions struct {
	ListOptions
	Search *string `url:"search,omitempty" json:"search,omitempty"`
}

ListProtectedBranchesOptions represents the available ListProtectedBranches() options.

GitLab API docs: https://docs.gitlab.com/api/protected_branches/#list-protected-branches

type ListProtectedEnvironmentsOptions added in v0.116.0 

type ListProtectedEnvironmentsOptions struct {
	ListOptions
}

ListProtectedEnvironmentsOptions represents the available ListProtectedEnvironments() options.

GitLab API docs: https://docs.gitlab.com/api/protected_environments/#list-protected-environments

type ListProtectedTagsOptions added in v0.116.0 

type ListProtectedTagsOptions struct {
	ListOptions
}

ListProtectedTagsOptions represents the available ListProtectedTags() options.

GitLab API docs: https://docs.gitlab.com/api/protected_tags/#list-protected-tags

type ListProvisionedUsersOptions added in v0.116.0 

type ListProvisionedUsersOptions struct {
	ListOptions
	Username      *string    `url:"username,omitempty" json:"username,omitempty"`
	Search        *string    `url:"search,omitempty" json:"search,omitempty"`
	Active        *bool      `url:"active,omitempty" json:"active,omitempty"`
	Blocked       *bool      `url:"blocked,omitempty" json:"blocked,omitempty"`
	CreatedAfter  *time.Time `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore *time.Time `url:"created_before,omitempty" json:"created_before,omitempty"`
}

ListProvisionedUsersOptions represents the available ListProvisionedUsers() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-provisioned-users

type ListRegistryRepositoryTagsOptions added in v0.116.0 

type ListRegistryRepositoryTagsOptions struct {
	ListOptions
}

ListRegistryRepositoryTagsOptions represents the available ListRegistryRepositoryTags() options.

GitLab API docs: https://docs.gitlab.com/api/container_registry/#list-registry-repository-tags

type ListRelatedIssuesOptions added in v0.128.0 

type ListRelatedIssuesOptions struct {
	ListOptions
}

ListRelatedIssuesOptions represents the available ListRelatedIssues() options.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-issues-related-to-the-merge-request

type ListReleaseLinksOptions added in v0.116.0 

type ListReleaseLinksOptions struct {
	ListOptions
}

ListReleaseLinksOptions represents ListReleaseLinks() options.

GitLab API docs: https://docs.gitlab.com/api/releases/links/#list-links-of-a-release

type ListReleasesOptions added in v0.116.0 

type ListReleasesOptions struct {
	ListOptions
	OrderBy                *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                   *string `url:"sort,omitempty" json:"sort,omitempty"`
	IncludeHTMLDescription *bool   `url:"include_html_description,omitempty" json:"include_html_description,omitempty"`
}

ListReleasesOptions represents ListReleases() options.

GitLab API docs: https://docs.gitlab.com/api/releases/#list-releases

type ListRunnerControllerTokensOptions added in v1.10.0 

type ListRunnerControllerTokensOptions struct {
	ListOptions
}

ListRunnerControllerTokensOptions represents the available ListRunnerControllerTokens() options.

GitLab API docs: https://docs.gitlab.com/api/runner_controller_tokens/#list-all-runner-controller-tokens

type ListRunnerControllersOptions added in v1.10.0 

type ListRunnerControllersOptions struct {
	ListOptions
}

ListRunnerControllersOptions represents the available ListRunnerControllers() options.

GitLab API docs: https://docs.gitlab.com/api/runner_controllers/#list-all-runner-controllers

type ListRunnerJobsOptions added in v0.8.0 

type ListRunnerJobsOptions struct {
	ListOptions
	Status  *string `url:"status,omitempty" json:"status,omitempty"`
	OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort    *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListRunnerJobsOptions represents the available ListRunnerJobs() options. Status can be one of: running, success, failed, canceled.

GitLab API docs: https://docs.gitlab.com/api/runners/#list-jobs-processed-by-a-runner

type ListRunnersOptions added in v0.7.5 

type ListRunnersOptions struct {
	ListOptions
	Type    *string   `url:"type,omitempty" json:"type,omitempty"`
	Status  *string   `url:"status,omitempty" json:"status,omitempty"`
	Paused  *bool     `url:"paused,omitempty" json:"paused,omitempty"`
	TagList *[]string `url:"tag_list,comma,omitempty" json:"tag_list,omitempty"`

	// Deprecated: Use Type or Status instead.
	Scope *string `url:"scope,omitempty" json:"scope,omitempty"`
}

ListRunnersOptions represents the available ListRunners() options.

GitLab API docs: https://docs.gitlab.com/api/runners/#list-owned-runners

type ListSSHKeysForUserOptions added in v0.8.1 

type ListSSHKeysForUserOptions struct {
	ListOptions
}

ListSSHKeysForUserOptions represents the available ListSSHKeysForUser() options.

GitLab API docs: https://docs.gitlab.com/api/user_keys/#list-all-ssh-keys-for-a-user

type ListSSHKeysOptions added in v0.116.0 

type ListSSHKeysOptions struct {
	ListOptions
}

ListSSHKeysOptions represents the available ListSSHKeys options.

GitLab API docs: https://docs.gitlab.com/api/user_keys/#list-all-ssh-keys

type ListServiceAccountPersonalAccessTokensOptions added in v0.132.0 

type ListServiceAccountPersonalAccessTokensOptions struct {
	ListOptions
	CreatedAfter   *time.Time `url:"created_after,omitempty" json:"created_after,omitempty"`
	CreatedBefore  *time.Time `url:"created_before,omitempty" json:"created_before,omitempty"`
	ExpiresAfter   *ISOTime   `url:"expires_after,omitempty" json:"expires_after,omitempty"`
	ExpiresBefore  *ISOTime   `url:"expires_before,omitempty" json:"expires_before,omitempty"`
	LastUsedAfter  *time.Time `url:"last_used_after,omitempty" json:"last_used_after,omitempty"`
	LastUsedBefore *time.Time `url:"last_used_before,omitempty" json:"last_used_before,omitempty"`
	Revoked        *bool      `url:"revoked,omitempty" json:"revoked,omitempty"`
	UserID         *int64     `url:"user_id,omitempty" json:"user_id,omitempty"`
	Search         *string    `url:"search,omitempty" json:"search,omitempty"`
	Sort           *string    `url:"sort,omitempty" json:"sort,omitempty"`
	State          *string    `url:"state,omitempty" json:"state,omitempty"`
}

ListServiceAccountPersonalAccessTokensOptions represents the available ListServiceAccountPersonalAccessTokens() options.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#list-all-personal-access-tokens-for-a-group-service-account

type ListServiceAccountsOptions added in v0.116.0 

type ListServiceAccountsOptions struct {
	ListOptions
	OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort    *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListServiceAccountsOptions represents the available ListServiceAccounts() options.

GitLab API docs: https://docs.gitlab.com/api/service_accounts/#list-all-group-service-accounts

type ListSnippetDiscussionsOptions added in v0.11.2 

type ListSnippetDiscussionsOptions struct {
	ListOptions
}

ListSnippetDiscussionsOptions represents the available ListSnippetDiscussions() options.

GitLab API docs: https://docs.gitlab.com/api/discussions/#list-project-snippet-discussion-items

type ListSnippetNotesOptions added in v0.8.1 

type ListSnippetNotesOptions struct {
	ListOptions
	OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort    *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListSnippetNotesOptions represents the available ListSnippetNotes() options.

GitLab API docs: https://docs.gitlab.com/api/notes/#list-all-snippet-notes

type ListSnippetsOptions 

type ListSnippetsOptions struct {
	ListOptions
}

ListSnippetsOptions represents the available ListSnippets() options.

GitLab API docs: https://docs.gitlab.com/api/snippets/#list-all-snippets-for-current-user

type ListStateEventsOptions added in v0.116.0 

type ListStateEventsOptions struct {
	ListOptions
}

ListStateEventsOptions represents the options for all resource state events list methods.

GitLab API docs: https://docs.gitlab.com/api/resource_state_events/#list-project-issue-state-events

type ListStatusOfAllGeoSitesOptions added in v0.128.0 

type ListStatusOfAllGeoSitesOptions struct {
	ListOptions
}

ListStatusOfAllGeoSitesOptions represents the available ListStatusOfAllGeoSites() options.

GitLab API docs: https://docs.gitlab.com/api/geo_sites/#list-all-geo-site-statuses

type ListSubGroupsOptions added in v0.116.0 

type ListSubGroupsOptions ListGroupsOptions

ListSubGroupsOptions represents the available ListSubGroups() options.

GitLab API docs: https://docs.gitlab.com/api/groups/#list-subgroups

type ListTagsOptions added in v0.7.4 

type ListTagsOptions struct {
	ListOptions
	OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
	Search  *string `url:"search,omitempty" json:"search,omitempty"`
	Sort    *string `url:"sort,omitempty" json:"sort,omitempty"`
}

ListTagsOptions represents the available ListTags() options.

GitLab API docs: https://docs.gitlab.com/api/tags/#list-project-repository-tags

type ListTemplatesOptions added in v0.9.0 

type ListTemplatesOptions struct {
	ListOptions
}

ListTemplatesOptions represents the available ListAllTemplates() options.

GitLab API docs: https://docs.gitlab.com/api/templates/gitignores/#get-all-gitignore-templates

type ListTodosOptions added in v0.6.0 

type ListTodosOptions struct {
	ListOptions
	Action    *TodoAction `url:"action,omitempty" json:"action,omitempty"`
	AuthorID  *int64      `url:"author_id,omitempty" json:"author_id,omitempty"`
	ProjectID *int64      `url:"project_id,omitempty" json:"project_id,omitempty"`
	GroupID   *int64      `url:"group_id,omitempty" json:"group_id,omitempty"`
	State     *string     `url:"state,omitempty" json:"state,omitempty"`
	Type      *string     `url:"type,omitempty" json:"type,omitempty"`
}

ListTodosOptions represents the available ListTodos() options.

GitLab API docs: https://docs.gitlab.com/api/todos/#get-a-list-of-to-do-items

type ListTopicsOptions added in v0.116.0 

type ListTopicsOptions struct {
	ListOptions
	Search *string `url:"search,omitempty" json:"search,omitempty"`
}

ListTopicsOptions represents the available ListTopics() options.

GitLab API docs: https://docs.gitlab.com/api/topics/#list-topics

type ListTreeOptions 

type ListTreeOptions struct {
	ListOptions
	Path      *string `url:"path,omitempty" json:"path,omitempty"`
	Ref       *string `url:"ref,omitempty" json:"ref,omitempty"`
	Recursive *bool   `url:"recursive,omitempty" json:"recursive,omitempty"`
}

ListTreeOptions represents the available ListTree() options.

GitLab API docs: https://docs.gitlab.com/api/repositories/#list-repository-tree

type ListUserProjectDeployKeysOptions added in v0.130.0 

type ListUserProjectDeployKeysOptions struct {
	ListOptions
}

ListUserProjectDeployKeysOptions represents the available ListUserProjectDeployKeys() options.

GitLab API docs: https://docs.gitlab.com/api/deploy_keys/#list-project-deploy-keys-for-user

type ListUsersOptions 

type ListUsersOptions struct {
	ListOptions
	Active          *bool   `url:"active,omitempty" json:"active,omitempty"`
	Blocked         *bool   `url:"blocked,omitempty" json:"blocked,omitempty"`
	Humans          *bool   `url:"humans,omitempty" json:"humans,omitempty"`
	ExcludeInternal *bool   `url:"exclude_internal,omitempty" json:"exclude_internal,omitempty"`
	ExcludeActive   *bool   `url:"exclude_active,omitempty" json:"exclude_active,omitempty"`
	ExcludeExternal *bool   `url:"exclude_external,omitempty" json:"exclude_external,omitempty"`
	ExcludeHumans   *bool   `url:"exclude_humans,omitempty" json:"exclude_humans,omitempty"`
	PublicEmail     *string `url:"public_email,omitempty" json:"public_email,omitempty"`

	// The options below are only available for admins.
	Search               *string    `url:"search,omitempty" json:"search,omitempty"`
	Username             *string    `url:"username,omitempty" json:"username,omitempty"`
	ExternalUID          *string    `url:"extern_uid,omitempty" json:"extern_uid,omitempty"`
	Provider             *string    `url:"provider,omitempty" json:"provider,omitempty"`
	CreatedBefore        *time.Time `url:"created_before,omitempty" json:"created_before,omitempty"`
	CreatedAfter         *time.Time `url:"created_after,omitempty" json:"created_after,omitempty"`
	OrderBy              *string    `url:"order_by,omitempty" json:"order_by,omitempty"`
	Sort                 *string    `url:"sort,omitempty" json:"sort,omitempty"`
	TwoFactor            *string    `url:"two_factor,omitempty" json:"two_factor,omitempty"`
	Admins               *bool      `url:"admins,omitempty" json:"admins,omitempty"`
	External             *bool      `url:"external,omitempty" json:"external,omitempty"`
	WithoutProjects      *bool      `url:"without_projects,omitempty" json:"without_projects,omitempty"`
	WithCustomAttributes *bool      `url:"with_custom_attributes,omitempty" json:"with_custom_attributes,omitempty"`
	WithoutProjectBots   *bool      `url:"without_project_bots,omitempty" json:"without_project_bots,omitempty"`
}

ListUsersOptions represents the available ListUsers() options.

GitLab API docs: https://docs.gitlab.com/api/users/#list-users

type ListWeightEventsOptions added in v0.116.0 

type ListWeightEventsOptions struct {
	ListOptions
}

ListWeightEventsOptions represents the options for all resource weight events list methods.

GitLab API docs: https://docs.gitlab.com/api/resource_weight_events/#list-project-issue-weight-events

type ListWikisOptions added in v0.7.0 

type ListWikisOptions struct {
	WithContent *bool `url:"with_content,omitempty" json:"with_content,omitempty"`
}

ListWikisOptions represents the available ListWikis options.

GitLab API docs: https://docs.gitlab.com/api/wikis/#list-wiki-pages

type ListWorkItemsOptions added in v1.34.0 

type ListWorkItemsOptions struct {
	AssigneeUsernames    []string
	AssigneeWildcardID   *string
	AuthorUsername       *string
	Confidential         *bool
	CRMContactID         *string
	CRMOrganizationID    *string
	HealthStatusFilter   *string
	IDs                  []string
	IIDs                 []string
	IncludeAncestors     *bool
	IncludeDescendants   *bool
	IterationCadenceID   []string
	IterationID          []string
	IterationWildcardID  *string
	LabelName            []string
	MilestoneTitle       []string
	MilestoneWildcardID  *string
	MyReactionEmoji      *string
	ParentIDs            []string
	ReleaseTag           []string
	ReleaseTagWildcardID *string
	State                *string
	Subscribed           *string
	Types                []string
	Weight               *string
	WeightWildcardID     *string

	// Time filters
	ClosedAfter   *time.Time
	ClosedBefore  *time.Time
	CreatedAfter  *time.Time
	CreatedBefore *time.Time
	DueAfter      *time.Time
	DueBefore     *time.Time
	UpdatedAfter  *time.Time
	UpdatedBefore *time.Time

	// Sorting
	Sort *string

	// Search
	Search *string
	In     []string

	// Pagination
	After  *string
	Before *string
	First  *int64
	Last   *int64
}

ListWorkItemsOptions represents the available ListWorkItems() options.

GitLab API docs: https://docs.gitlab.com/api/graphql/reference/#namespaceworkitems

type ManagementProject added in v0.116.0 

type ManagementProject struct {
	ID                int64      `json:"id"`
	Description       string     `json:"description"`
	Name              string     `json:"name"`
	NameWithNamespace string     `json:"name_with_namespace"`
	Path              string     `json:"path"`
	PathWithNamespace string     `json:"path_with_namespace"`
	CreatedAt         *time.Time `json:"created_at"`
}

ManagementProject represents a GitLab Project Cluster management_project. Deprecated: in GitLab 14.5, to be removed in 19.0

type MarkMigrationAsSuccessfulOptions added in v0.128.0 

type MarkMigrationAsSuccessfulOptions struct {
	Database string `url:"database,omitempty" json:"database,omitempty"`
}

MarkMigrationAsSuccessfulOptions represents the options to mark a migration as successful.

GitLab API docs: https://docs.gitlab.com/api/database_migrations/#mark-a-migration-as-successful

type Markdown added in v0.116.0 

type Markdown struct {
	HTML string `json:"html"`
}

Markdown represents a markdown document.

GitLab API docs: https://docs.gitlab.com/api/markdown/

type MarkdownService added in v0.116.0 

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

MarkdownService handles communication with the markdown related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/markdown/

func (*MarkdownService) Render added in v0.116.0 

func (s *MarkdownService) Render(opt *RenderOptions, options ...RequestOptionFunc) (*Markdown, *Response, error)

Render an arbitrary markdown document.

GitLab API docs: https://docs.gitlab.com/api/markdown/#render-an-arbitrary-markdown-document

type MarkdownServiceInterface added in v0.126.0 

type MarkdownServiceInterface interface {
	Render(opt *RenderOptions, options ...RequestOptionFunc) (*Markdown, *Response, error)
}

type MarkdownUpload added in v0.129.0 

type MarkdownUpload struct {
	ID         int64      `json:"id"`
	Size       int64      `json:"size"`
	Filename   string     `json:"filename"`
	CreatedAt  *time.Time `json:"created_at"`
	UploadedBy *User      `json:"uploaded_by"`
}

MarkdownUpload represents a single markdown upload.

GitLab API docs: https://docs.gitlab.com/api/project_markdown_uploads/ https://docs.gitlab.com/api/group_markdown_uploads/

func (MarkdownUpload) String added in v0.129.0 

func (m MarkdownUpload) String() string

String gets a string representation of a MarkdownUpload.

GitLab API docs: https://docs.gitlab.com/api/project_markdown_uploads/ https://docs.gitlab.com/api/group_markdown_uploads/

type MarkdownUploadedFile added in v0.129.0 

type MarkdownUploadedFile struct {
	ID       int64  `json:"id"`
	Alt      string `json:"alt"`
	URL      string `json:"url"`
	FullPath string `json:"full_path"`
	Markdown string `json:"markdown"`
}

MarkdownUploadedFile represents a single markdown uploaded file.

GitLab API docs: https://docs.gitlab.com/api/project_markdown_uploads/

type MatrixIntegration added in v1.19.0 

type MatrixIntegration struct {
	Integration
	Properties MatrixIntegrationProperties `json:"properties"`
}

MatrixIntegration represents the Matrix integration settings.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#matrix-notifications

type MatrixIntegrationProperties added in v1.19.0 

type MatrixIntegrationProperties struct {
	Hostname                  string `json:"hostname,omitempty"`
	Room                      string `json:"room,omitempty"`
	NotifyOnlyBrokenPipelines bool   `json:"notify_only_broken_pipelines,omitempty"`
	BranchesToBeNotified      string `json:"branches_to_be_notified,omitempty"`
}

MatrixIntegrationProperties represents Matrix specific properties.

type MatrixService added in v1.9.0 

type MatrixService struct {
	Service
	Properties *MatrixServiceProperties `json:"properties"`
}

MatrixService represents Matrix service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#matrix-notifications

type MatrixServiceProperties added in v1.9.0 

type MatrixServiceProperties struct {
	Hostname                  string    `json:"hostname"`
	Token                     string    `json:"token"`
	Room                      string    `json:"room"`
	NotifyOnlyBrokenPipelines BoolValue `json:"notify_only_broken_pipelines"`
	BranchesToBeNotified      string    `json:"branches_to_be_notified"`
	UseInheritedSettings      BoolValue `json:"use_inherited_settings"`
}

MatrixServiceProperties represents Matrix specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#matrix-notifications

type MattermostIntegration added in v1.19.0 

type MattermostIntegration struct {
	Integration
	Properties MattermostIntegrationProperties `json:"properties"`
}

MattermostIntegration represents the Mattermost integration settings.

GitLab API docs: https://docs.gitlab.com/api/group_integrations/#mattermost-notifications

type MattermostIntegrationProperties added in v1.19.0 

type MattermostIntegrationProperties struct {
	Username                   string `json:"username,omitempty"`
	Channel                    string `json:"channel,omitempty"`
	NotifyOnlyBrokenPipelines  bool   `json:"notify_only_broken_pipelines,omitempty"`
	BranchesToBeNotified       string `json:"branches_to_be_notified,omitempty"`
	LabelsToBeNotified         string `json:"labels_to_be_notified,omitempty"`
	LabelsToBeNotifiedBehavior string `json:"labels_to_be_notified_behavior,omitempty"`
	PushChannel                string `json:"push_channel,omitempty"`
	IssueChannel               string `json:"issue_channel,omitempty"`
	ConfidentialIssueChannel   string `json:"confidential_issue_channel,omitempty"`
	MergeRequestChannel        string `json:"merge_request_channel,omitempty"`
	NoteChannel                string `json:"note_channel,omitempty"`
	ConfidentialNoteChannel    string `json:"confidential_note_channel,omitempty"`
	TagPushChannel             string `json:"tag_push_channel,omitempty"`
	PipelineChannel            string `json:"pipeline_channel,omitempty"`
	WikiPageChannel            string `json:"wiki_page_channel,omitempty"`
	DeploymentChannel          string `json:"deployment_channel,omitempty"`
	IncidentChannel            string `json:"incident_channel,omitempty"`
}

MattermostIntegrationProperties represents Mattermost specific properties.

type MattermostService added in v0.116.0 

type MattermostService struct {
	Service
	Properties *MattermostServiceProperties `json:"properties"`
}

MattermostService represents Mattermost service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#mattermost-notifications

type MattermostServiceProperties added in v0.116.0 

type MattermostServiceProperties struct {
	WebHook                   string    `json:"webhook"`
	Username                  string    `json:"username"`
	Channel                   string    `json:"channel"`
	NotifyOnlyBrokenPipelines BoolValue `json:"notify_only_broken_pipelines"`
	BranchesToBeNotified      string    `json:"branches_to_be_notified"`
	ConfidentialIssueChannel  string    `json:"confidential_issue_channel"`
	ConfidentialNoteChannel   string    `json:"confidential_note_channel"`
	IssueChannel              string    `json:"issue_channel"`
	MergeRequestChannel       string    `json:"merge_request_channel"`
	NoteChannel               string    `json:"note_channel"`
	TagPushChannel            string    `json:"tag_push_channel"`
	PipelineChannel           string    `json:"pipeline_channel"`
	PushChannel               string    `json:"push_channel"`
	VulnerabilityChannel      string    `json:"vulnerability_channel"`
	WikiPageChannel           string    `json:"wiki_page_channel"`
}

MattermostServiceProperties represents Mattermost specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#mattermost-notifications

type MattermostSlashCommandsProperties added in v0.116.0 

type MattermostSlashCommandsProperties struct {
	Token    string `json:"token"`
	Username string `json:"username,omitempty"`
}

MattermostSlashCommandsProperties represents Mattermost slash commands specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#mattermost-slash-commands

type MattermostSlashCommandsService added in v0.116.0 

type MattermostSlashCommandsService struct {
	Service
	Properties *MattermostSlashCommandsProperties `json:"properties"`
}

MattermostSlashCommandsService represents Mattermost slash commands settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#mattermost-slash-commands

type MemberCreatedBy added in v0.145.0 

type MemberCreatedBy struct {
	ID        int64  `json:"id"`
	Username  string `json:"username"`
	Name      string `json:"name"`
	State     string `json:"state"`
	AvatarURL string `json:"avatar_url"`
	WebURL    string `json:"web_url"`
}

type MemberEvent added in v0.116.0 

type MemberEvent struct {
	CreatedAt    *time.Time `json:"created_at"`
	UpdatedAt    *time.Time `json:"updated_at"`
	GroupName    string     `json:"group_name"`
	GroupPath    string     `json:"group_path"`
	GroupID      int64      `json:"group_id"`
	UserUsername string     `json:"user_username"`
	UserName     string     `json:"user_name"`
	UserEmail    string     `json:"user_email"`
	UserID       int64      `json:"user_id"`
	GroupAccess  string     `json:"group_access"`
	GroupPlan    string     `json:"group_plan"`
	ExpiresAt    *time.Time `json:"expires_at"`
	EventName    string     `json:"event_name"`
}

MemberEvent represents a member event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#group-member-events

type MemberRole added in v0.116.0 

type MemberRole struct {
	ID                         int64            `json:"id"`
	Name                       string           `json:"name"`
	Description                string           `json:"description,omitempty"`
	GroupID                    int64            `json:"group_id"`
	BaseAccessLevel            AccessLevelValue `json:"base_access_level"`
	AdminCICDVariables         bool             `json:"admin_cicd_variables,omitempty"`
	AdminComplianceFramework   bool             `json:"admin_compliance_framework,omitempty"`
	AdminGroupMembers          bool             `json:"admin_group_member,omitempty"`
	AdminMergeRequests         bool             `json:"admin_merge_request,omitempty"`
	AdminPushRules             bool             `json:"admin_push_rules,omitempty"`
	AdminTerraformState        bool             `json:"admin_terraform_state,omitempty"`
	AdminVulnerability         bool             `json:"admin_vulnerability,omitempty"`
	AdminWebHook               bool             `json:"admin_web_hook,omitempty"`
	ArchiveProject             bool             `json:"archive_project,omitempty"`
	ManageDeployTokens         bool             `json:"manage_deploy_tokens,omitempty"`
	ManageGroupAccessTokens    bool             `json:"manage_group_access_tokens,omitempty"`
	ManageMergeRequestSettings bool             `json:"manage_merge_request_settings,omitempty"`
	ManageProjectAccessTokens  bool             `json:"manage_project_access_tokens,omitempty"`
	ManageSecurityPolicyLink   bool             `json:"manage_security_policy_link,omitempty"`
	ReadCode                   bool             `json:"read_code,omitempty"`
	ReadRunners                bool             `json:"read_runners,omitempty"`
	ReadDependency             bool             `json:"read_dependency,omitempty"`
	ReadVulnerability          bool             `json:"read_vulnerability,omitempty"`
	RemoveGroup                bool             `json:"remove_group,omitempty"`
	RemoveProject              bool             `json:"remove_project,omitempty"`
}

MemberRole represents a GitLab member role.

GitLab API docs: https://docs.gitlab.com/api/member_roles/#list-all-member-roles-of-a-group

type MemberRolesService added in v0.116.0 

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

MemberRolesService handles communication with the member roles related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/member_roles/#list-all-member-roles-of-a-group

func (*MemberRolesService) CreateInstanceMemberRole added in v0.124.0 

func (s *MemberRolesService) CreateInstanceMemberRole(opt *CreateMemberRoleOptions, options ...RequestOptionFunc) (*MemberRole, *Response, error)

CreateInstanceMemberRole creates an instance-wide member role.

GitLab API docs: https://docs.gitlab.com/api/member_roles/#create-a-instance-member-role

func (*MemberRolesService) CreateMemberRole added in v0.116.0 

func (s *MemberRolesService) CreateMemberRole(gid any, opt *CreateMemberRoleOptions, options ...RequestOptionFunc) (*MemberRole, *Response, error)

CreateMemberRole creates a new member role for a specified group.

GitLab API docs: https://docs.gitlab.com/api/member_roles/#add-a-member-role-to-a-group

func (*MemberRolesService) DeleteInstanceMemberRole added in v0.124.0 

func (s *MemberRolesService) DeleteInstanceMemberRole(memberRoleID int64, options ...RequestOptionFunc) (*Response, error)

DeleteInstanceMemberRole deletes a member role from a specified group.

GitLab API docs: https://docs.gitlab.com/api/member_roles/#delete-an-instance-member-role

func (*MemberRolesService) DeleteMemberRole added in v0.116.0 

func (s *MemberRolesService) DeleteMemberRole(gid any, memberRole int64, options ...RequestOptionFunc) (*Response, error)

DeleteMemberRole deletes a member role from a specified group.

GitLab API docs: https://docs.gitlab.com/api/member_roles/#remove-member-role-of-a-group

func (*MemberRolesService) ListInstanceMemberRoles added in v0.124.0 

func (s *MemberRolesService) ListInstanceMemberRoles(options ...RequestOptionFunc) ([]*MemberRole, *Response, error)

ListInstanceMemberRoles gets all member roles in an instance. Authentication as Administrator is required.

GitLab API docs: https://docs.gitlab.com/api/member_roles/#get-all-instance-member-roles

func (*MemberRolesService) ListMemberRoles added in v0.116.0 

func (s *MemberRolesService) ListMemberRoles(gid any, options ...RequestOptionFunc) ([]*MemberRole, *Response, error)

ListMemberRoles gets a list of member roles for a specified group.

GitLab API docs: https://docs.gitlab.com/api/member_roles/#get-all-group-member-roles

type MemberRolesServiceInterface added in v0.126.0 

type MemberRolesServiceInterface interface {
	ListInstanceMemberRoles(options ...RequestOptionFunc) ([]*MemberRole, *Response, error)
	CreateInstanceMemberRole(opt *CreateMemberRoleOptions, options ...RequestOptionFunc) (*MemberRole, *Response, error)
	DeleteInstanceMemberRole(memberRoleID int64, options ...RequestOptionFunc) (*Response, error)
	ListMemberRoles(gid any, options ...RequestOptionFunc) ([]*MemberRole, *Response, error)
	CreateMemberRole(gid any, opt *CreateMemberRoleOptions, options ...RequestOptionFunc) (*MemberRole, *Response, error)
	DeleteMemberRole(gid any, memberRole int64, options ...RequestOptionFunc) (*Response, error)
}

type MergeBaseOptions added in v0.116.0 

type MergeBaseOptions struct {
	Ref *[]string `url:"refs[],omitempty" json:"refs,omitempty"`
}

MergeBaseOptions represents the available MergeBase() options.

GitLab API docs: https://docs.gitlab.com/api/repositories/#merge-base

type MergeCommentEvent added in v0.3.1 

type MergeCommentEvent struct {
	ObjectKind       string                            `json:"object_kind"`
	EventType        string                            `json:"event_type"`
	User             *EventUser                        `json:"user"`
	ProjectID        int64                             `json:"project_id"`
	Project          MergeCommentEventProject          `json:"project"`
	ObjectAttributes MergeCommentEventObjectAttributes `json:"object_attributes"`
	Repository       *Repository                       `json:"repository"`
	MergeRequest     MergeCommentEventMergeRequest     `json:"merge_request"`
}

MergeCommentEvent represents a comment on a merge event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#comment-on-a-merge-request

type MergeCommentEventMergeRequest added in v1.0.0 

type MergeCommentEventMergeRequest struct {
	ID                        int64                       `json:"id"`
	TargetBranch              string                      `json:"target_branch"`
	SourceBranch              string                      `json:"source_branch"`
	SourceProjectID           int64                       `json:"source_project_id"`
	AuthorID                  int64                       `json:"author_id"`
	AssigneeID                int64                       `json:"assignee_id"`
	AssigneeIDs               []int64                     `json:"assignee_ids"`
	ReviewerIDs               []int64                     `json:"reviewer_ids"`
	Title                     string                      `json:"title"`
	CreatedAt                 string                      `json:"created_at"`
	UpdatedAt                 string                      `json:"updated_at"`
	MilestoneID               int64                       `json:"milestone_id"`
	State                     string                      `json:"state"`
	MergeStatus               string                      `json:"merge_status"`
	TargetProjectID           int64                       `json:"target_project_id"`
	IID                       int64                       `json:"iid"`
	Description               string                      `json:"description"`
	Position                  int64                       `json:"position"`
	Labels                    []*EventLabel               `json:"labels"`
	LockedAt                  string                      `json:"locked_at"`
	UpdatedByID               int64                       `json:"updated_by_id"`
	MergeError                string                      `json:"merge_error"`
	MergeParams               *MergeParams                `json:"merge_params"`
	MergeWhenPipelineSucceeds bool                        `json:"merge_when_pipeline_succeeds"`
	MergeUserID               int64                       `json:"merge_user_id"`
	MergeCommitSHA            string                      `json:"merge_commit_sha"`
	DeletedAt                 string                      `json:"deleted_at"`
	InProgressMergeCommitSHA  string                      `json:"in_progress_merge_commit_sha"`
	LockVersion               int64                       `json:"lock_version"`
	ApprovalsBeforeMerge      string                      `json:"approvals_before_merge"`
	RebaseCommitSHA           string                      `json:"rebase_commit_sha"`
	TimeEstimate              int64                       `json:"time_estimate"`
	Squash                    bool                        `json:"squash"`
	LastEditedAt              string                      `json:"last_edited_at"`
	LastEditedByID            int64                       `json:"last_edited_by_id"`
	Source                    *Repository                 `json:"source"`
	Target                    *Repository                 `json:"target"`
	LastCommit                EventMergeRequestLastCommit `json:"last_commit"`
	WorkInProgress            bool                        `json:"work_in_progress"`
	TotalTimeSpent            int64                       `json:"total_time_spent"`
	HeadPipelineID            int64                       `json:"head_pipeline_id"`
	Assignee                  *EventUser                  `json:"assignee"`
	DetailedMergeStatus       string                      `json:"detailed_merge_status"`
	URL                       string                      `json:"url"`
}

type MergeCommentEventObjectAttributes added in v1.0.0 

type MergeCommentEventObjectAttributes struct {
	Attachment       string             `json:"attachment"`
	AuthorID         int64              `json:"author_id"`
	ChangePosition   *NotePosition      `json:"change_position"`
	CommitID         string             `json:"commit_id"`
	CreatedAt        string             `json:"created_at"`
	DiscussionID     string             `json:"discussion_id"`
	ID               int64              `json:"id"`
	LineCode         string             `json:"line_code"`
	Note             string             `json:"note"`
	NoteableID       int64              `json:"noteable_id"`
	NoteableType     string             `json:"noteable_type"`
	OriginalPosition *NotePosition      `json:"original_position"`
	Position         *NotePosition      `json:"position"`
	ProjectID        int64              `json:"project_id"`
	ResolvedAt       string             `json:"resolved_at"`
	ResolvedByID     int64              `json:"resolved_by_id"`
	ResolvedByPush   bool               `json:"resolved_by_push"`
	StDiff           *Diff              `json:"st_diff"`
	System           bool               `json:"system"`
	Type             string             `json:"type"`
	UpdatedAt        string             `json:"updated_at"`
	UpdatedByID      int64              `json:"updated_by_id"`
	Description      string             `json:"description"`
	Action           CommentEventAction `json:"action"`
	URL              string             `json:"url"`
}

type MergeCommentEventProject added in v1.0.0 

type MergeCommentEventProject struct {
	ID                int64           `json:"id"`
	Name              string          `json:"name"`
	Description       string          `json:"description"`
	AvatarURL         string          `json:"avatar_url"`
	GitSSHURL         string          `json:"git_ssh_url"`
	GitHTTPURL        string          `json:"git_http_url"`
	Namespace         string          `json:"namespace"`
	PathWithNamespace string          `json:"path_with_namespace"`
	DefaultBranch     string          `json:"default_branch"`
	Homepage          string          `json:"homepage"`
	URL               string          `json:"url"`
	SSHURL            string          `json:"ssh_url"`
	HTTPURL           string          `json:"http_url"`
	WebURL            string          `json:"web_url"`
	Visibility        VisibilityValue `json:"visibility"`
}

type MergeEvent added in v0.3.1 

type MergeEvent struct {
	ObjectKind       string                     `json:"object_kind"`
	EventType        string                     `json:"event_type"`
	User             *EventUser                 `json:"user"`
	Project          MergeEventProject          `json:"project"`
	ObjectAttributes MergeEventObjectAttributes `json:"object_attributes"`
	Repository       *Repository                `json:"repository"`
	Labels           []*EventLabel              `json:"labels"`
	Changes          MergeEventChanges          `json:"changes"`
	Assignees        []*EventUser               `json:"assignees"`
	Reviewers        []*EventUser               `json:"reviewers"`
}

MergeEvent represents a merge event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#merge-request-events

type MergeEventChanges added in v1.0.0 

type MergeEventChanges struct {
	Assignees       EventChangesAssignees            `json:"assignees"`
	Reviewers       MergeEventChangesReviewers       `json:"reviewers"`
	Description     EventChangesDescription          `json:"description"`
	Draft           MergeEventChangesDraft           `json:"draft"`
	Labels          EventChangesLabels               `json:"labels"`
	LastEditedAt    MergeEventChangesLastEditedAt    `json:"last_edited_at"`
	LastEditedByID  MergeEventChangesLastEditedByID  `json:"last_edited_by_id"`
	MergeStatus     MergeEventChangesMergeStatus     `json:"merge_status"`
	MilestoneID     MergeEventChangesMilestoneID     `json:"milestone_id"`
	SourceBranch    MergeEventChangesSourceBranch    `json:"source_branch"`
	SourceProjectID MergeEventChangesSourceProjectID `json:"source_project_id"`
	StateID         EventChangesStateID              `json:"state_id"`
	TargetBranch    MergeEventChangesTargetBranch    `json:"target_branch"`
	TargetProjectID MergeEventChangesTargetProjectID `json:"target_project_id"`
	Title           EventChangesTitle                `json:"title"`
	UpdatedAt       EventChangesUpdatedAt            `json:"updated_at"`
	UpdatedByID     EventChangesUpdatedByID          `json:"updated_by_id"`
}

type MergeEventChangesDraft added in v1.0.0 

type MergeEventChangesDraft struct {
	Previous bool `json:"previous"`
	Current  bool `json:"current"`
}

type MergeEventChangesLastEditedAt added in v1.0.0 

type MergeEventChangesLastEditedAt struct {
	Previous string `json:"previous"`
	Current  string `json:"current"`
}

type MergeEventChangesLastEditedByID added in v1.0.0 

type MergeEventChangesLastEditedByID struct {
	Previous int64 `json:"previous"`
	Current  int64 `json:"current"`
}

type MergeEventChangesMergeStatus added in v1.0.0 

type MergeEventChangesMergeStatus struct {
	Previous string `json:"previous"`
	Current  string `json:"current"`
}

type MergeEventChangesMilestoneID added in v1.0.0 

type MergeEventChangesMilestoneID struct {
	Previous int64 `json:"previous"`
	Current  int64 `json:"current"`
}

type MergeEventChangesReviewers added in v1.0.0 

type MergeEventChangesReviewers struct {
	Previous []*EventUser `json:"previous"`
	Current  []*EventUser `json:"current"`
}

type MergeEventChangesSourceBranch added in v1.0.0 

type MergeEventChangesSourceBranch struct {
	Previous string `json:"previous"`
	Current  string `json:"current"`
}

type MergeEventChangesSourceProjectID added in v1.0.0 

type MergeEventChangesSourceProjectID struct {
	Previous int64 `json:"previous"`
	Current  int64 `json:"current"`
}

type MergeEventChangesTargetBranch added in v1.0.0 

type MergeEventChangesTargetBranch struct {
	Previous string `json:"previous"`
	Current  string `json:"current"`
}

type MergeEventChangesTargetProjectID added in v1.0.0 

type MergeEventChangesTargetProjectID struct {
	Previous int64 `json:"previous"`
	Current  int64 `json:"current"`
}

type MergeEventObjectAttributes added in v1.0.0 

type MergeEventObjectAttributes struct {
	ID                          int64                       `json:"id"`
	TargetBranch                string                      `json:"target_branch"`
	SourceBranch                string                      `json:"source_branch"`
	SourceProjectID             int64                       `json:"source_project_id"`
	AuthorID                    int64                       `json:"author_id"`
	AssigneeID                  int64                       `json:"assignee_id"`
	AssigneeIDs                 []int64                     `json:"assignee_ids"`
	ReviewerIDs                 []int64                     `json:"reviewer_ids"`
	Title                       string                      `json:"title"`
	CreatedAt                   string                      `json:"created_at"` // Should be *time.Time (see Gitlab issue #21468)
	UpdatedAt                   string                      `json:"updated_at"` // Should be *time.Time (see Gitlab issue #21468)
	StCommits                   []*Commit                   `json:"st_commits"`
	StDiffs                     []*Diff                     `json:"st_diffs"`
	LastEditedAt                string                      `json:"last_edited_at"`
	LastEditedByID              int64                       `json:"last_edited_by_id"`
	MilestoneID                 int64                       `json:"milestone_id"`
	StateID                     StateID                     `json:"state_id"`
	State                       string                      `json:"state"`
	MergeStatus                 string                      `json:"merge_status"`
	TargetProjectID             int64                       `json:"target_project_id"`
	IID                         int64                       `json:"iid"`
	Description                 string                      `json:"description"`
	Position                    int64                       `json:"position"`
	LockedAt                    string                      `json:"locked_at"`
	UpdatedByID                 int64                       `json:"updated_by_id"`
	MergeError                  string                      `json:"merge_error"`
	MergeParams                 *MergeParams                `json:"merge_params"`
	MergeWhenBuildSucceeds      bool                        `json:"merge_when_build_succeeds"`
	MergeUserID                 int64                       `json:"merge_user_id"`
	MergeCommitSHA              string                      `json:"merge_commit_sha"`
	DeletedAt                   string                      `json:"deleted_at"`
	ApprovalsBeforeMerge        string                      `json:"approvals_before_merge"`
	RebaseCommitSHA             string                      `json:"rebase_commit_sha"`
	InProgressMergeCommitSHA    string                      `json:"in_progress_merge_commit_sha"`
	LockVersion                 int64                       `json:"lock_version"`
	TimeEstimate                int64                       `json:"time_estimate"`
	Source                      *Repository                 `json:"source"`
	Target                      *Repository                 `json:"target"`
	HeadPipelineID              *int64                      `json:"head_pipeline_id"`
	LastCommit                  EventMergeRequestLastCommit `json:"last_commit"`
	BlockingDiscussionsResolved bool                        `json:"blocking_discussions_resolved"`
	WorkInProgress              bool                        `json:"work_in_progress"`
	Draft                       bool                        `json:"draft"`
	TotalTimeSpent              int64                       `json:"total_time_spent"`
	TimeChange                  int64                       `json:"time_change"`
	HumanTotalTimeSpent         string                      `json:"human_total_time_spent"`
	HumanTimeChange             string                      `json:"human_time_change"`
	HumanTimeEstimate           string                      `json:"human_time_estimate"`
	FirstContribution           bool                        `json:"first_contribution"`
	URL                         string                      `json:"url"`
	Labels                      []*EventLabel               `json:"labels"`
	Action                      string                      `json:"action"`
	DetailedMergeStatus         string                      `json:"detailed_merge_status"`
	OldRev                      string                      `json:"oldrev"`
	System                      bool                        `json:"system"`
	SystemAction                string                      `json:"system_action"`
}

type MergeEventProject added in v1.0.0 

type MergeEventProject struct {
	ID                int64           `json:"id"`
	Name              string          `json:"name"`
	Description       string          `json:"description"`
	AvatarURL         string          `json:"avatar_url"`
	GitSSHURL         string          `json:"git_ssh_url"`
	GitHTTPURL        string          `json:"git_http_url"`
	Namespace         string          `json:"namespace"`
	PathWithNamespace string          `json:"path_with_namespace"`
	DefaultBranch     string          `json:"default_branch"`
	CIConfigPath      string          `json:"ci_config_path"`
	Homepage          string          `json:"homepage"`
	URL               string          `json:"url"`
	SSHURL            string          `json:"ssh_url"`
	HTTPURL           string          `json:"http_url"`
	WebURL            string          `json:"web_url"`
	Visibility        VisibilityValue `json:"visibility"`
}

type MergeMethodValue added in v0.10.5 

type MergeMethodValue string

MergeMethodValue represents a project merge type within GitLab.

GitLab API docs: https://docs.gitlab.com/api/projects/#project-merge-method 

const (
	NoFastForwardMerge MergeMethodValue = "merge"
	FastForwardMerge   MergeMethodValue = "ff"
	RebaseMerge        MergeMethodValue = "rebase_merge"
)

List of available merge type

GitLab API docs: https://docs.gitlab.com/api/projects/#project-merge-method

type MergeParams added in v0.116.0 

type MergeParams struct {
	ForceRemoveSourceBranch bool `json:"force_remove_source_branch"`
}

MergeParams represents the merge params.

func (*MergeParams) UnmarshalJSON added in v0.116.0 

func (p *MergeParams) UnmarshalJSON(b []byte) error

UnmarshalJSON decodes the merge parameters

This allows support of ForceRemoveSourceBranch for both type bool (>11.9) and string (<11.9)

type MergeRequest 

type MergeRequest struct {
	BasicMergeRequest
	MergeError                  string               `json:"merge_error"`
	Subscribed                  bool                 `json:"subscribed"`
	ChangesCount                string               `json:"changes_count"`
	User                        MergeRequestUser     `json:"user"`
	LatestBuildStartedAt        *time.Time           `json:"latest_build_started_at"`
	LatestBuildFinishedAt       *time.Time           `json:"latest_build_finished_at"`
	FirstDeployedToProductionAt *time.Time           `json:"first_deployed_to_production_at"`
	Pipeline                    *PipelineInfo        `json:"pipeline"`
	HeadPipeline                *Pipeline            `json:"head_pipeline"`
	DiffRefs                    MergeRequestDiffRefs `json:"diff_refs"`
	RebaseInProgress            bool                 `json:"rebase_in_progress"`
	DivergedCommitsCount        int64                `json:"diverged_commits_count"`
	FirstContribution           bool                 `json:"first_contribution"`

	// Deprecated: use Draft instead
	WorkInProgress bool `json:"work_in_progress"`
}

MergeRequest represents a GitLab merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/

func (MergeRequest) String 

func (m MergeRequest) String() string

func (*MergeRequest) UnmarshalJSON added in v0.116.0 

func (m *MergeRequest) UnmarshalJSON(data []byte) error

type MergeRequestApprovalRule added in v0.116.0 

type MergeRequestApprovalRule struct {
	ID                   int64                `json:"id"`
	Name                 string               `json:"name"`
	RuleType             string               `json:"rule_type"`
	ReportType           string               `json:"report_type"`
	EligibleApprovers    []*BasicUser         `json:"eligible_approvers"`
	ApprovalsRequired    int64                `json:"approvals_required"`
	SourceRule           *ProjectApprovalRule `json:"source_rule"`
	Users                []*BasicUser         `json:"users"`
	Groups               []*Group             `json:"groups"`
	ContainsHiddenGroups bool                 `json:"contains_hidden_groups"`
	Section              string               `json:"section"`
	ApprovedBy           []*BasicUser         `json:"approved_by"`
	Approved             bool                 `json:"approved"`
}

MergeRequestApprovalRule represents a GitLab merge request approval rule.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#get-merge-request-approval-rules

func (MergeRequestApprovalRule) String added in v0.116.0 

func (s MergeRequestApprovalRule) String() string

String is a stringify for MergeRequestApprovalRule

type MergeRequestApprovalSetting added in v0.125.0 

type MergeRequestApprovalSetting struct {
	Value         bool   `json:"value"`
	Locked        bool   `json:"locked"`
	InheritedFrom string `json:"inherited_from"`
}

MergeRequestApprovalSetting represents an individual merge request approval setting.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approval_settings/

type MergeRequestApprovalSettings added in v0.125.0 

type MergeRequestApprovalSettings struct {
	AllowAuthorApproval                         MergeRequestApprovalSetting `json:"allow_author_approval"`
	AllowCommitterApproval                      MergeRequestApprovalSetting `json:"allow_committer_approval"`
	AllowOverridesToApproverListPerMergeRequest MergeRequestApprovalSetting `json:"allow_overrides_to_approver_list_per_merge_request"`
	RetainApprovalsOnPush                       MergeRequestApprovalSetting `json:"retain_approvals_on_push"`
	SelectiveCodeOwnerRemovals                  MergeRequestApprovalSetting `json:"selective_code_owner_removals"`
	RequirePasswordToApprove                    MergeRequestApprovalSetting `json:"require_password_to_approve"`
	RequireReauthenticationToApprove            MergeRequestApprovalSetting `json:"require_reauthentication_to_approve"`
}

MergeRequestApprovalSettings represents the merge request approval settings.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approval_settings/

type MergeRequestApprovalSettingsService added in v0.125.0 

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

MergeRequestApprovalSettingsService handles communication with the merge requests approval settings related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approval_settings/

func (*MergeRequestApprovalSettingsService) GetGroupMergeRequestApprovalSettings added in v0.125.0 

func (s *MergeRequestApprovalSettingsService) GetGroupMergeRequestApprovalSettings(gid any, options ...RequestOptionFunc) (*MergeRequestApprovalSettings, *Response, error)

GetGroupMergeRequestApprovalSettings gets the merge request approval settings of a group.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approval_settings/#get-group-mr-approval-settings

func (*MergeRequestApprovalSettingsService) GetProjectMergeRequestApprovalSettings added in v0.125.0 

func (s *MergeRequestApprovalSettingsService) GetProjectMergeRequestApprovalSettings(pid any, options ...RequestOptionFunc) (*MergeRequestApprovalSettings, *Response, error)

GetProjectMergeRequestApprovalSettings gets the merge request approval settings of a project.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approval_settings/#get-project-mr-approval-settings

func (*MergeRequestApprovalSettingsService) UpdateGroupMergeRequestApprovalSettings added in v0.125.0 

func (s *MergeRequestApprovalSettingsService) UpdateGroupMergeRequestApprovalSettings(gid any, opt *UpdateGroupMergeRequestApprovalSettingsOptions, options ...RequestOptionFunc) (*MergeRequestApprovalSettings, *Response, error)

UpdateGroupMergeRequestApprovalSettings updates the merge request approval settings of a group.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approval_settings/#update-group-mr-approval-settings

func (*MergeRequestApprovalSettingsService) UpdateProjectMergeRequestApprovalSettings added in v0.125.0 

func (s *MergeRequestApprovalSettingsService) UpdateProjectMergeRequestApprovalSettings(pid any, opt *UpdateProjectMergeRequestApprovalSettingsOptions, options ...RequestOptionFunc) (*MergeRequestApprovalSettings, *Response, error)

UpdateProjectMergeRequestApprovalSettings updates the merge request approval settings of a project.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approval_settings/#update-project-mr-approval-settings

type MergeRequestApprovalSettingsServiceInterface added in v0.126.0 

type MergeRequestApprovalSettingsServiceInterface interface {
	GetGroupMergeRequestApprovalSettings(gid any, options ...RequestOptionFunc) (*MergeRequestApprovalSettings, *Response, error)
	UpdateGroupMergeRequestApprovalSettings(gid any, opt *UpdateGroupMergeRequestApprovalSettingsOptions, options ...RequestOptionFunc) (*MergeRequestApprovalSettings, *Response, error)
	GetProjectMergeRequestApprovalSettings(pid any, options ...RequestOptionFunc) (*MergeRequestApprovalSettings, *Response, error)
	UpdateProjectMergeRequestApprovalSettings(pid any, opt *UpdateProjectMergeRequestApprovalSettingsOptions, options ...RequestOptionFunc) (*MergeRequestApprovalSettings, *Response, error)
}

type MergeRequestApprovalState added in v0.116.0 

type MergeRequestApprovalState struct {
	ApprovalRulesOverwritten bool                        `json:"approval_rules_overwritten"`
	Rules                    []*MergeRequestApprovalRule `json:"rules"`
}

MergeRequestApprovalState represents a GitLab merge request approval state.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#get-the-approval-state-of-merge-requests

type MergeRequestApprovals added in v0.6.2 

type MergeRequestApprovals struct {
	ID                             int64                        `json:"id"`
	IID                            int64                        `json:"iid"`
	ProjectID                      int64                        `json:"project_id"`
	Title                          string                       `json:"title"`
	Description                    string                       `json:"description"`
	State                          string                       `json:"state"`
	CreatedAt                      *time.Time                   `json:"created_at"`
	UpdatedAt                      *time.Time                   `json:"updated_at"`
	MergeStatus                    string                       `json:"merge_status"`
	Approved                       bool                         `json:"approved"`
	ApprovalsBeforeMerge           int64                        `json:"approvals_before_merge"`
	ApprovalsRequired              int64                        `json:"approvals_required"`
	ApprovalsLeft                  int64                        `json:"approvals_left"`
	RequirePasswordToApprove       bool                         `json:"require_password_to_approve"`
	ApprovedBy                     []*MergeRequestApproverUser  `json:"approved_by"`
	SuggestedApprovers             []*BasicUser                 `json:"suggested_approvers"`
	Approvers                      []*MergeRequestApproverUser  `json:"approvers"`
	ApproverGroups                 []*MergeRequestApproverGroup `json:"approver_groups"`
	UserHasApproved                bool                         `json:"user_has_approved"`
	UserCanApprove                 bool                         `json:"user_can_approve"`
	ApprovalRulesLeft              []*MergeRequestApprovalRule  `json:"approval_rules_left"`
	HasApprovalRules               bool                         `json:"has_approval_rules"`
	MergeRequestApproversAvailable bool                         `json:"merge_request_approvers_available"`
	MultipleApprovalRulesAvailable bool                         `json:"multiple_approval_rules_available"`
}

MergeRequestApprovals represents GitLab merge request approvals.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#single-merge-request-approval

func (MergeRequestApprovals) String added in v0.6.2 

func (m MergeRequestApprovals) String() string

type MergeRequestApprovalsService added in v0.10.0 

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

MergeRequestApprovalsService handles communication with the merge request approvals related methods of the GitLab API. This includes reading/updating approval settings and approve/unapproving merge requests

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/

func (*MergeRequestApprovalsService) ApproveMergeRequest added in v0.10.0 

func (s *MergeRequestApprovalsService) ApproveMergeRequest(pid any, mr int64, opt *ApproveMergeRequestOptions, options ...RequestOptionFunc) (*MergeRequestApprovals, *Response, error)

ApproveMergeRequest approves a merge request on GitLab. If a non-empty sha is provided then it must match the sha at the HEAD of the MR.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#approve-merge-request

func (*MergeRequestApprovalsService) ChangeApprovalConfiguration deprecated added in v0.116.0 

func (s *MergeRequestApprovalsService) ChangeApprovalConfiguration(pid any, mergeRequest int64, opt *ChangeMergeRequestApprovalConfigurationOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)

ChangeApprovalConfiguration updates the approval configuration of a merge request.

Deprecated: in GitLab 16.0

func (*MergeRequestApprovalsService) CreateApprovalRule added in v0.116.0 

func (s *MergeRequestApprovalsService) CreateApprovalRule(pid any, mergeRequest int64, opt *CreateMergeRequestApprovalRuleOptions, options ...RequestOptionFunc) (*MergeRequestApprovalRule, *Response, error)

CreateApprovalRule creates a new MR level approval rule.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#create-merge-request-rule

func (*MergeRequestApprovalsService) DeleteApprovalRule added in v0.116.0 

func (s *MergeRequestApprovalsService) DeleteApprovalRule(pid any, mergeRequest int64, approvalRule int64, options ...RequestOptionFunc) (*Response, error)

DeleteApprovalRule deletes a mr level approval rule.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#delete-merge-request-rule

func (*MergeRequestApprovalsService) GetApprovalRules added in v0.116.0 

func (s *MergeRequestApprovalsService) GetApprovalRules(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*MergeRequestApprovalRule, *Response, error)

GetApprovalRules requests information about a merge request's approval rules

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#get-merge-request-approval-rules

func (*MergeRequestApprovalsService) GetApprovalState added in v0.116.0 

func (s *MergeRequestApprovalsService) GetApprovalState(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequestApprovalState, *Response, error)

GetApprovalState requests information about a merge request's approval state

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#get-the-approval-state-of-merge-requests

func (*MergeRequestApprovalsService) GetConfiguration added in v0.116.0 

func (s *MergeRequestApprovalsService) GetConfiguration(pid any, mr int64, options ...RequestOptionFunc) (*MergeRequestApprovals, *Response, error)

GetConfiguration shows information about single merge request approvals

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#single-merge-request-approval

func (*MergeRequestApprovalsService) ResetApprovalsOfMergeRequest added in v0.116.0 

func (s *MergeRequestApprovalsService) ResetApprovalsOfMergeRequest(pid any, mr int64, options ...RequestOptionFunc) (*Response, error)

ResetApprovalsOfMergeRequest clear all approvals of merge request on GitLab. Available only for bot users based on project or group tokens.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#reset-approvals-of-a-merge-request

func (*MergeRequestApprovalsService) UnapproveMergeRequest added in v0.10.0 

func (s *MergeRequestApprovalsService) UnapproveMergeRequest(pid any, mr int64, options ...RequestOptionFunc) (*Response, error)

UnapproveMergeRequest unapproves a previously approved merge request on GitLab.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#unapprove-merge-request

func (*MergeRequestApprovalsService) UpdateApprovalRule added in v0.116.0 

func (s *MergeRequestApprovalsService) UpdateApprovalRule(pid any, mergeRequest int64, approvalRule int64, opt *UpdateMergeRequestApprovalRuleOptions, options ...RequestOptionFunc) (*MergeRequestApprovalRule, *Response, error)

UpdateApprovalRule updates an existing approval rule with new options.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#update-merge-request-rule

type MergeRequestApprovalsServiceInterface added in v0.126.0 

type MergeRequestApprovalsServiceInterface interface {
	ApproveMergeRequest(pid any, mr int64, opt *ApproveMergeRequestOptions, options ...RequestOptionFunc) (*MergeRequestApprovals, *Response, error)
	UnapproveMergeRequest(pid any, mr int64, options ...RequestOptionFunc) (*Response, error)
	ResetApprovalsOfMergeRequest(pid any, mr int64, options ...RequestOptionFunc) (*Response, error)
	GetConfiguration(pid any, mr int64, options ...RequestOptionFunc) (*MergeRequestApprovals, *Response, error)
	ChangeApprovalConfiguration(pid any, mergeRequest int64, opt *ChangeMergeRequestApprovalConfigurationOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)
	GetApprovalRules(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*MergeRequestApprovalRule, *Response, error)
	GetApprovalState(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequestApprovalState, *Response, error)
	CreateApprovalRule(pid any, mergeRequest int64, opt *CreateMergeRequestApprovalRuleOptions, options ...RequestOptionFunc) (*MergeRequestApprovalRule, *Response, error)
	UpdateApprovalRule(pid any, mergeRequest int64, approvalRule int64, opt *UpdateMergeRequestApprovalRuleOptions, options ...RequestOptionFunc) (*MergeRequestApprovalRule, *Response, error)
	DeleteApprovalRule(pid any, mergeRequest int64, approvalRule int64, options ...RequestOptionFunc) (*Response, error)
}

type MergeRequestApproverGroup added in v0.116.0 

type MergeRequestApproverGroup struct {
	Group MergeRequestApproverNestedGroup `json:"group"`
}

MergeRequestApproverGroup represents GitLab project level merge request approver group.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#project-approval-rules

type MergeRequestApproverNestedGroup added in v1.0.0 

type MergeRequestApproverNestedGroup struct {
	ID                   int64  `json:"id"`
	Name                 string `json:"name"`
	Path                 string `json:"path"`
	Description          string `json:"description"`
	Visibility           string `json:"visibility"`
	AvatarURL            string `json:"avatar_url"`
	WebURL               string `json:"web_url"`
	FullName             string `json:"full_name"`
	FullPath             string `json:"full_path"`
	LFSEnabled           bool   `json:"lfs_enabled"`
	RequestAccessEnabled bool   `json:"request_access_enabled"`
}

type MergeRequestApproverUser added in v0.116.0 

type MergeRequestApproverUser struct {
	User *BasicUser
}

MergeRequestApproverUser represents GitLab project level merge request approver user.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#project-approval-rules

type MergeRequestContextCommitsService added in v0.157.0 

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

MergeRequestContextCommitsService handles communication with the merge request context commits related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/merge_request_context_commits/

func (*MergeRequestContextCommitsService) CreateMergeRequestContextCommits added in v0.157.0 

func (s *MergeRequestContextCommitsService) CreateMergeRequestContextCommits(pid any, mergeRequest int64, opt *CreateMergeRequestContextCommitsOptions, options ...RequestOptionFunc) ([]*Commit, *Response, error)

func (*MergeRequestContextCommitsService) DeleteMergeRequestContextCommits added in v0.157.0 

func (s *MergeRequestContextCommitsService) DeleteMergeRequestContextCommits(pid any, mergeRequest int64, opt *DeleteMergeRequestContextCommitsOptions, options ...RequestOptionFunc) (*Response, error)

func (*MergeRequestContextCommitsService) ListMergeRequestContextCommits added in v0.157.0 

func (s *MergeRequestContextCommitsService) ListMergeRequestContextCommits(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*Commit, *Response, error)

type MergeRequestContextCommitsServiceInterface added in v0.157.0 

type MergeRequestContextCommitsServiceInterface interface {
	// ListMergeRequestContextCommits gets a list of merge request context commits.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/merge_request_context_commits/#list-mr-context-commits
	ListMergeRequestContextCommits(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*Commit, *Response, error)
	// CreateMergeRequestContextCommits creates a list of merge request context
	// commits.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/merge_request_context_commits/#create-mr-context-commits
	CreateMergeRequestContextCommits(pid any, mergeRequest int64, opt *CreateMergeRequestContextCommitsOptions, options ...RequestOptionFunc) ([]*Commit, *Response, error)
	// DeleteMergeRequestContextCommits deletes a list of merge request context
	// commits.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/merge_request_context_commits/#delete-mr-context-commits
	DeleteMergeRequestContextCommits(pid any, mergeRequest int64, opt *DeleteMergeRequestContextCommitsOptions, options ...RequestOptionFunc) (*Response, error)
}

MergeRequestContextCommitsServiceInterface handles communication with the merge request context commits related methods of the GitLab API.

type MergeRequestDependency added in v0.119.0 

type MergeRequestDependency struct {
	ID                   int64                `json:"id"`
	BlockingMergeRequest BlockingMergeRequest `json:"blocking_merge_request"`
	ProjectID            int64                `json:"project_id"`
}

MergeRequestDependency represents a GitLab merge request dependency.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#create-a-merge-request-dependency

func (MergeRequestDependency) String added in v0.119.0 

func (m MergeRequestDependency) String() string

type MergeRequestDiff added in v0.116.0 

type MergeRequestDiff struct {
	OldPath       string `json:"old_path"`
	NewPath       string `json:"new_path"`
	AMode         string `json:"a_mode"`
	BMode         string `json:"b_mode"`
	Diff          string `json:"diff"`
	NewFile       bool   `json:"new_file"`
	RenamedFile   bool   `json:"renamed_file"`
	DeletedFile   bool   `json:"deleted_file"`
	GeneratedFile bool   `json:"generated_file"`
	Collapsed     bool   `json:"collapsed"`
	TooLarge      bool   `json:"too_large"`
}

MergeRequestDiff represents GitLab merge request diff.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-merge-request-diffs

type MergeRequestDiffRefs added in v1.0.0 

type MergeRequestDiffRefs struct {
	BaseSha  string `json:"base_sha"`
	HeadSha  string `json:"head_sha"`
	StartSha string `json:"start_sha"`
}

MergeRequestDiffRefs represents a GitLab merge request diff refs.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/

func (MergeRequestDiffRefs) String added in v1.0.0 

func (d MergeRequestDiffRefs) String() string

type MergeRequestDiffVersion added in v0.7.4 

type MergeRequestDiffVersion struct {
	ID             int64      `json:"id"`
	HeadCommitSHA  string     `json:"head_commit_sha,omitempty"`
	BaseCommitSHA  string     `json:"base_commit_sha,omitempty"`
	StartCommitSHA string     `json:"start_commit_sha,omitempty"`
	CreatedAt      *time.Time `json:"created_at,omitempty"`
	MergeRequestID int64      `json:"merge_request_id,omitempty"`
	State          string     `json:"state,omitempty"`
	RealSize       string     `json:"real_size,omitempty"`
	Commits        []*Commit  `json:"commits,omitempty"`
	Diffs          []*Diff    `json:"diffs,omitempty"`
}

MergeRequestDiffVersion represents GitLab merge request version.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-merge-request-diff-versions

func (MergeRequestDiffVersion) String added in v0.7.4 

func (m MergeRequestDiffVersion) String() string

type MergeRequestReviewer added in v0.116.0 

type MergeRequestReviewer struct {
	User      *BasicUser `json:"user"`
	State     string     `json:"state"`
	CreatedAt *time.Time `json:"created_at"`
}

MergeRequestReviewer represents a reviewer entry returned by the reviewers API. Matches the JSON shape used in tests: {"user": {...}, "state": "...", "created_at": "..."} Placed here because it's used by MergeRequestsService.GetMergeRequestReviewers and tests/mock.

type MergeRequestUser added in v1.0.0 

type MergeRequestUser struct {
	CanMerge bool `json:"can_merge"`
}

MergeRequestUser represents a GitLab merge request user.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/

func (MergeRequestUser) String added in v1.0.0 

func (u MergeRequestUser) String() string

type MergeRequestsCount added in v0.128.0 

type MergeRequestsCount struct {
	MergeRequestsCount int64 `url:"merge_requests_count" json:"merge_requests_count"`
}

MergeRequestsCount represents the total count of recently created merge requests in a group.

GitLab API docs: https://docs.gitlab.com/api/group_activity_analytics/#get-count-of-recently-created-merge-requests-for-group

type MergeRequestsService 

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

MergeRequestsService handles communication with the merge requests related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/

func (*MergeRequestsService) AcceptMergeRequest 

func (s *MergeRequestsService) AcceptMergeRequest(pid any, mergeRequest int64, opt *AcceptMergeRequestOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)

AcceptMergeRequest merges changes submitted with MR using this API. If merge success you get 200 OK. If it has some conflicts and can not be merged - you get 405 and error message 'Branch cannot be merged'. If merge request is already merged or closed - you get 405 and error message 'Method Not Allowed'

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#merge-a-merge-request

func (*MergeRequestsService) AddSpentTime added in v0.6.0 

func (s *MergeRequestsService) AddSpentTime(pid any, mergeRequest int64, opt *AddSpentTimeOptions, options ...RequestOptionFunc) (*TimeStats, *Response, error)

AddSpentTime adds spent time for a single project merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#add-spent-time-for-a-merge-request

func (*MergeRequestsService) CancelMergeWhenPipelineSucceeds added in v0.7.4 

func (s *MergeRequestsService) CancelMergeWhenPipelineSucceeds(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequest, *Response, error)

CancelMergeWhenPipelineSucceeds cancels a merge when pipeline succeeds. If you don't have permissions to accept this merge request - you'll get a 401. If the merge request is already merged or closed - you get 405 and error message 'Method Not Allowed'. In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a 406 error.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#cancel-merge-when-pipeline-succeeds

func (*MergeRequestsService) CreateMergeRequest 

func (s *MergeRequestsService) CreateMergeRequest(pid any, opt *CreateMergeRequestOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)

CreateMergeRequest creates a new merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#create-mr

func (*MergeRequestsService) CreateMergeRequestDependency added in v0.119.0 

func (s *MergeRequestsService) CreateMergeRequestDependency(pid any, mergeRequest int64, opts CreateMergeRequestDependencyOptions, options ...RequestOptionFunc) (*MergeRequestDependency, *Response, error)

CreateMergeRequestDependency creates a new merge request dependency for a given merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#create-a-merge-request-dependency

func (*MergeRequestsService) CreateMergeRequestPipeline added in v0.116.0 

func (s *MergeRequestsService) CreateMergeRequestPipeline(pid any, mergeRequest int64, options ...RequestOptionFunc) (*PipelineInfo, *Response, error)

CreateMergeRequestPipeline creates a new pipeline for a merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#create-merge-request-pipeline

func (*MergeRequestsService) CreateTodo added in v0.7.4 

func (s *MergeRequestsService) CreateTodo(pid any, mergeRequest int64, options ...RequestOptionFunc) (*Todo, *Response, error)

CreateTodo manually creates a todo for the current user on a merge request. If there already exists a todo for the user on that merge request, status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#create-a-to-do-item

func (*MergeRequestsService) DeleteMergeRequest added in v0.7.4 

func (s *MergeRequestsService) DeleteMergeRequest(pid any, mergeRequest int64, options ...RequestOptionFunc) (*Response, error)

DeleteMergeRequest deletes a merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#delete-a-merge-request

func (*MergeRequestsService) DeleteMergeRequestDependency added in v0.119.0 

func (s *MergeRequestsService) DeleteMergeRequestDependency(pid any, mergeRequest int64, blockingMergeRequest int64, options ...RequestOptionFunc) (*Response, error)

DeleteMergeRequestDependency deletes a merge request dependency for a given merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#delete-a-merge-request-dependency

func (*MergeRequestsService) GetIssuesClosedOnMerge added in v0.7.3 

func (s *MergeRequestsService) GetIssuesClosedOnMerge(pid any, mergeRequest int64, opt *GetIssuesClosedOnMergeOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)

GetIssuesClosedOnMerge gets all the issues that would be closed by merging the provided merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-issues-that-close-on-merge

func (*MergeRequestsService) GetMergeRequest 

func (s *MergeRequestsService) GetMergeRequest(pid any, mergeRequest int64, opt *GetMergeRequestsOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)

GetMergeRequest shows information about a single merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-single-mr

func (*MergeRequestsService) GetMergeRequestApprovals added in v0.6.2 

func (s *MergeRequestsService) GetMergeRequestApprovals(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequestApprovals, *Response, error)

GetMergeRequestApprovals gets information about a merge requests approvals

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#single-merge-request-approval

func (*MergeRequestsService) GetMergeRequestChanges deprecated 

func (s *MergeRequestsService) GetMergeRequestChanges(pid any, mergeRequest int64, opt *GetMergeRequestChangesOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)

GetMergeRequestChanges shows information about the merge request including its files and changes.

Deprecated: This endpoint has been replaced by MergeRequestsService.ListMergeRequestDiffs()

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-single-merge-request-changes

func (*MergeRequestsService) GetMergeRequestCommits added in v0.4.0 

func (s *MergeRequestsService) GetMergeRequestCommits(pid any, mergeRequest int64, opt *GetMergeRequestCommitsOptions, options ...RequestOptionFunc) ([]*Commit, *Response, error)

GetMergeRequestCommits gets a list of merge request commits.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-single-merge-request-commits

func (*MergeRequestsService) GetMergeRequestDependencies added in v0.119.0 

func (s *MergeRequestsService) GetMergeRequestDependencies(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]MergeRequestDependency, *Response, error)

GetMergeRequestDependencies gets a list of merge request dependencies.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-merge-request-dependencies

func (*MergeRequestsService) GetMergeRequestDiffVersions added in v0.7.4 

func (s *MergeRequestsService) GetMergeRequestDiffVersions(pid any, mergeRequest int64, opt *GetMergeRequestDiffVersionsOptions, options ...RequestOptionFunc) ([]*MergeRequestDiffVersion, *Response, error)

GetMergeRequestDiffVersions get a list of merge request diff versions.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-merge-request-diff-versions

func (*MergeRequestsService) GetMergeRequestParticipants added in v0.116.0 

func (s *MergeRequestsService) GetMergeRequestParticipants(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*BasicUser, *Response, error)

GetMergeRequestParticipants gets a list of merge request participants.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-single-merge-request-participants

func (*MergeRequestsService) GetMergeRequestReviewers added in v0.116.0 

func (s *MergeRequestsService) GetMergeRequestReviewers(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*MergeRequestReviewer, *Response, error)

GetMergeRequestReviewers gets a list of merge request reviewers.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-single-merge-request-reviewers

func (*MergeRequestsService) GetSingleMergeRequestDiffVersion added in v0.7.4 

func (s *MergeRequestsService) GetSingleMergeRequestDiffVersion(pid any, mergeRequest, version int64, opt *GetSingleMergeRequestDiffVersionOptions, options ...RequestOptionFunc) (*MergeRequestDiffVersion, *Response, error)

GetSingleMergeRequestDiffVersion get a single MR diff version

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-a-single-merge-request-diff-version

func (*MergeRequestsService) GetTimeSpent added in v0.6.0 

func (s *MergeRequestsService) GetTimeSpent(pid any, mergeRequest int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)

GetTimeSpent gets the spent time for a single project merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#get-time-tracking-stats

func (*MergeRequestsService) ListGroupMergeRequests added in v0.11.1 

func (s *MergeRequestsService) ListGroupMergeRequests(gid any, opt *ListGroupMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)

ListGroupMergeRequests gets all merge requests for this group.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-group-merge-requests

func (*MergeRequestsService) ListMergeRequestDiffs added in v0.116.0 

func (s *MergeRequestsService) ListMergeRequestDiffs(pid any, mergeRequest int64, opt *ListMergeRequestDiffsOptions, options ...RequestOptionFunc) ([]*MergeRequestDiff, *Response, error)

ListMergeRequestDiffs List diffs of the files changed in a merge request

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-merge-request-diffs

func (*MergeRequestsService) ListMergeRequestPipelines added in v0.9.0 

func (s *MergeRequestsService) ListMergeRequestPipelines(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*PipelineInfo, *Response, error)

ListMergeRequestPipelines gets all pipelines for the provided merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-merge-request-pipelines

func (*MergeRequestsService) ListMergeRequests 

func (s *MergeRequestsService) ListMergeRequests(opt *ListMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)

ListMergeRequests gets all merge requests. The state parameter can be used to get only merge requests with a given state (opened, closed, or merged) or all of them (all). The pagination parameters page and per_page can be used to restrict the list of merge requests.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-merge-requests

func (*MergeRequestsService) ListProjectMergeRequests added in v0.6.2 

func (s *MergeRequestsService) ListProjectMergeRequests(pid any, opt *ListProjectMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)

ListProjectMergeRequests gets all merge requests for this project.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-project-merge-requests

func (*MergeRequestsService) ListRelatedIssues added in v0.128.0 

func (s *MergeRequestsService) ListRelatedIssues(pid any, mergeRequest int64, opt *ListRelatedIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)

ListRelatedIssues gets all the issues related to provided merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#list-issues-related-to-the-merge-request

func (*MergeRequestsService) RebaseMergeRequest added in v0.116.0 

func (s *MergeRequestsService) RebaseMergeRequest(pid any, mergeRequest int64, opt *RebaseMergeRequestOptions, options ...RequestOptionFunc) (*Response, error)

RebaseMergeRequest automatically rebases the source_branch of the merge request against its target_branch. If you don’t have permissions to push to the merge request’s source branch, you’ll get a 403 Forbidden response.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#rebase-a-merge-request

func (*MergeRequestsService) ResetSpentTime added in v0.6.0 

func (s *MergeRequestsService) ResetSpentTime(pid any, mergeRequest int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)

ResetSpentTime resets the spent time for a single project merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#reset-spent-time-for-a-merge-request

func (*MergeRequestsService) ResetTimeEstimate added in v0.6.0 

func (s *MergeRequestsService) ResetTimeEstimate(pid any, mergeRequest int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)

ResetTimeEstimate resets the time estimate for a single project merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#reset-the-time-estimate-for-a-merge-request

func (*MergeRequestsService) SetTimeEstimate added in v0.6.0 

func (s *MergeRequestsService) SetTimeEstimate(pid any, mergeRequest int64, opt *SetTimeEstimateOptions, options ...RequestOptionFunc) (*TimeStats, *Response, error)

SetTimeEstimate sets the time estimate for a single project merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#set-a-time-estimate-for-a-merge-request

func (*MergeRequestsService) ShowMergeRequestRawDiffs added in v0.121.0 

func (s *MergeRequestsService) ShowMergeRequestRawDiffs(pid any, mergeRequest int64, opt *ShowMergeRequestRawDiffsOptions, options ...RequestOptionFunc) ([]byte, *Response, error)

ShowMergeRequestRawDiffs Show raw diffs of the files changed in a merge request

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#show-merge-request-raw-diffs

func (*MergeRequestsService) SubscribeToMergeRequest added in v0.7.4 

func (s *MergeRequestsService) SubscribeToMergeRequest(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequest, *Response, error)

SubscribeToMergeRequest subscribes the authenticated user to the given merge request to receive notifications. If the user is already subscribed to the merge request, the status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#subscribe-to-a-merge-request

func (*MergeRequestsService) UnsubscribeFromMergeRequest added in v0.7.4 

func (s *MergeRequestsService) UnsubscribeFromMergeRequest(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequest, *Response, error)

UnsubscribeFromMergeRequest unsubscribes the authenticated user from the given merge request to not receive notifications from that merge request. If the user is not subscribed to the merge request, status code 304 is returned.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#unsubscribe-from-a-merge-request

func (*MergeRequestsService) UpdateMergeRequest 

func (s *MergeRequestsService) UpdateMergeRequest(pid any, mergeRequest int64, opt *UpdateMergeRequestOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)

UpdateMergeRequest updates an existing project milestone.

GitLab API docs: https://docs.gitlab.com/api/merge_requests/#update-mr

type MergeRequestsServiceInterface added in v0.126.0 

type MergeRequestsServiceInterface interface {
	ListMergeRequests(opt *ListMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)
	ListProjectMergeRequests(pid any, opt *ListProjectMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)
	ListGroupMergeRequests(gid any, opt *ListGroupMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)
	GetMergeRequest(pid any, mergeRequest int64, opt *GetMergeRequestsOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)
	GetMergeRequestApprovals(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequestApprovals, *Response, error)
	GetMergeRequestCommits(pid any, mergeRequest int64, opt *GetMergeRequestCommitsOptions, options ...RequestOptionFunc) ([]*Commit, *Response, error)
	GetMergeRequestChanges(pid any, mergeRequest int64, opt *GetMergeRequestChangesOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)
	ListMergeRequestDiffs(pid any, mergeRequest int64, opt *ListMergeRequestDiffsOptions, options ...RequestOptionFunc) ([]*MergeRequestDiff, *Response, error)
	ShowMergeRequestRawDiffs(pid any, mergeRequest int64, opt *ShowMergeRequestRawDiffsOptions, options ...RequestOptionFunc) ([]byte, *Response, error)
	GetMergeRequestParticipants(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*BasicUser, *Response, error)
	GetMergeRequestReviewers(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*MergeRequestReviewer, *Response, error)
	ListMergeRequestPipelines(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]*PipelineInfo, *Response, error)
	CreateMergeRequestPipeline(pid any, mergeRequest int64, options ...RequestOptionFunc) (*PipelineInfo, *Response, error)
	GetIssuesClosedOnMerge(pid any, mergeRequest int64, opt *GetIssuesClosedOnMergeOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)
	ListRelatedIssues(pid any, mergeRequest int64, opt *ListRelatedIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)
	CreateMergeRequest(pid any, opt *CreateMergeRequestOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)
	UpdateMergeRequest(pid any, mergeRequest int64, opt *UpdateMergeRequestOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)
	DeleteMergeRequest(pid any, mergeRequest int64, options ...RequestOptionFunc) (*Response, error)
	AcceptMergeRequest(pid any, mergeRequest int64, opt *AcceptMergeRequestOptions, options ...RequestOptionFunc) (*MergeRequest, *Response, error)
	CancelMergeWhenPipelineSucceeds(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequest, *Response, error)
	RebaseMergeRequest(pid any, mergeRequest int64, opt *RebaseMergeRequestOptions, options ...RequestOptionFunc) (*Response, error)
	GetMergeRequestDiffVersions(pid any, mergeRequest int64, opt *GetMergeRequestDiffVersionsOptions, options ...RequestOptionFunc) ([]*MergeRequestDiffVersion, *Response, error)
	GetSingleMergeRequestDiffVersion(pid any, mergeRequest, version int64, opt *GetSingleMergeRequestDiffVersionOptions, options ...RequestOptionFunc) (*MergeRequestDiffVersion, *Response, error)
	SubscribeToMergeRequest(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequest, *Response, error)
	UnsubscribeFromMergeRequest(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeRequest, *Response, error)
	CreateTodo(pid any, mergeRequest int64, options ...RequestOptionFunc) (*Todo, *Response, error)
	SetTimeEstimate(pid any, mergeRequest int64, opt *SetTimeEstimateOptions, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	ResetTimeEstimate(pid any, mergeRequest int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	AddSpentTime(pid any, mergeRequest int64, opt *AddSpentTimeOptions, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	ResetSpentTime(pid any, mergeRequest int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	GetTimeSpent(pid any, mergeRequest int64, options ...RequestOptionFunc) (*TimeStats, *Response, error)
	CreateMergeRequestDependency(pid any, mergeRequest int64, opts CreateMergeRequestDependencyOptions, options ...RequestOptionFunc) (*MergeRequestDependency, *Response, error)
	DeleteMergeRequestDependency(pid any, mergeRequest int64, blockingMergeRequest int64, options ...RequestOptionFunc) (*Response, error)
	GetMergeRequestDependencies(pid any, mergeRequest int64, options ...RequestOptionFunc) ([]MergeRequestDependency, *Response, error)
}

type MergeStatusCheck added in v0.116.0 

type MergeStatusCheck struct {
	ID          int64  `json:"id"`
	Name        string `json:"name"`
	ExternalURL string `json:"external_url"`
	Status      string `json:"status"`
}

type MergeTrain added in v0.116.0 

type MergeTrain struct {
	ID           int64                   `json:"id"`
	MergeRequest *MergeTrainMergeRequest `json:"merge_request"`
	User         *BasicUser              `json:"user"`
	Pipeline     *Pipeline               `json:"pipeline"`
	CreatedAt    *time.Time              `json:"created_at"`
	UpdatedAt    *time.Time              `json:"updated_at"`
	TargetBranch string                  `json:"target_branch"`
	Status       string                  `json:"status"`
	MergedAt     *time.Time              `json:"merged_at"`
	Duration     int64                   `json:"duration"`
}

MergeTrain represents a GitLab merge train.

GitLab API docs: https://docs.gitlab.com/api/merge_trains/

type MergeTrainMergeRequest added in v0.116.0 

type MergeTrainMergeRequest struct {
	ID          int64      `json:"id"`
	IID         int64      `json:"iid"`
	ProjectID   int64      `json:"project_id"`
	Title       string     `json:"title"`
	Description string     `json:"description"`
	State       string     `json:"state"`
	CreatedAt   *time.Time `json:"created_at"`
	UpdatedAt   *time.Time `json:"updated_at"`
	WebURL      string     `json:"web_url"`
}

MergeTrainMergeRequest represents a GitLab merge request inside merge train.

GitLab API docs: https://docs.gitlab.com/api/merge_trains/

type MergeTrainsService added in v0.116.0 

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

MergeTrainsService handles communication with the merge trains related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/merge_trains/

func (*MergeTrainsService) AddMergeRequestToMergeTrain added in v0.116.0 

func (s *MergeTrainsService) AddMergeRequestToMergeTrain(pid any, mergeRequest int64, opts *AddMergeRequestToMergeTrainOptions, options ...RequestOptionFunc) ([]*MergeTrain, *Response, error)

AddMergeRequestToMergeTrain Add a merge request to the merge train targeting the merge request’s target branch.

GitLab API docs: https://docs.gitlab.com/api/merge_trains/#add-a-merge-request-to-a-merge-train

func (*MergeTrainsService) GetMergeRequestOnAMergeTrain added in v0.116.0 

func (s *MergeTrainsService) GetMergeRequestOnAMergeTrain(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeTrain, *Response, error)

GetMergeRequestOnAMergeTrain Get merge train information for the requested merge request.

GitLab API docs: https://docs.gitlab.com/api/merge_trains/#get-the-status-of-a-merge-request-on-a-merge-train

func (*MergeTrainsService) ListMergeRequestInMergeTrain added in v0.116.0 

func (s *MergeTrainsService) ListMergeRequestInMergeTrain(pid any, targetBranch string, opts *ListMergeTrainsOptions, options ...RequestOptionFunc) ([]*MergeTrain, *Response, error)

ListMergeRequestInMergeTrain gets a list of merge requests added to a merge train for the requested target branch.

GitLab API docs: https://docs.gitlab.com/api/merge_trains/#list-merge-requests-in-a-merge-train

func (*MergeTrainsService) ListProjectMergeTrains added in v0.116.0 

func (s *MergeTrainsService) ListProjectMergeTrains(pid any, opt *ListMergeTrainsOptions, options ...RequestOptionFunc) ([]*MergeTrain, *Response, error)

ListProjectMergeTrains get a list of merge trains in a project.

GitLab API docs: https://docs.gitlab.com/api/merge_trains/#list-merge-trains-for-a-project

type MergeTrainsServiceInterface added in v0.126.0 

type MergeTrainsServiceInterface interface {
	ListProjectMergeTrains(pid any, opt *ListMergeTrainsOptions, options ...RequestOptionFunc) ([]*MergeTrain, *Response, error)
	ListMergeRequestInMergeTrain(pid any, targetBranch string, opts *ListMergeTrainsOptions, options ...RequestOptionFunc) ([]*MergeTrain, *Response, error)
	GetMergeRequestOnAMergeTrain(pid any, mergeRequest int64, options ...RequestOptionFunc) (*MergeTrain, *Response, error)
	AddMergeRequestToMergeTrain(pid any, mergeRequest int64, opts *AddMergeRequestToMergeTrainOptions, options ...RequestOptionFunc) ([]*MergeTrain, *Response, error)
}

type Metadata added in v0.116.0 

type Metadata struct {
	Version    string      `json:"version"`
	Revision   string      `json:"revision"`
	KAS        MetadataKAS `json:"kas"`
	Enterprise bool        `json:"enterprise"`
}

Metadata represents a GitLab instance version.

GitLab API docs: https://docs.gitlab.com/api/metadata/

func (Metadata) String added in v0.116.0 

func (s Metadata) String() string

type MetadataKAS added in v1.0.0 

type MetadataKAS struct {
	Enabled             bool   `json:"enabled"`
	ExternalURL         string `json:"externalUrl"`
	ExternalK8SProxyURL string `json:"externalK8sProxyUrl"`
	Version             string `json:"version"`
}

MetadataKAS represents a GitLab instance version metadata KAS.

GitLab API docs: https://docs.gitlab.com/api/metadata/

func (MetadataKAS) String added in v1.0.0 

func (k MetadataKAS) String() string

type MetadataService added in v0.116.0 

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

MetadataService handles communication with the GitLab server instance to retrieve its metadata information via the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/metadata/

func (*MetadataService) GetMetadata added in v0.116.0 

func (s *MetadataService) GetMetadata(options ...RequestOptionFunc) (*Metadata, *Response, error)

GetMetadata gets a GitLab server instance meteadata.

GitLab API docs: https://docs.gitlab.com/api/metadata/

type MetadataServiceInterface added in v0.126.0 

type MetadataServiceInterface interface {
	GetMetadata(options ...RequestOptionFunc) (*Metadata, *Response, error)
}

type MetricImage added in v0.128.0 

type MetricImage struct {
	ID        int64      `json:"id"`
	CreatedAt *time.Time `json:"created_at"`
	Filename  string     `json:"filename"`
	FilePath  string     `json:"file_path"`
	URL       string     `json:"url"`
	URLText   string     `json:"url_text"`
}

MetricImage represents a single metric image file.

GitLab API docs: https://docs.gitlab.com/api/alert_management_alerts/

type MicrosoftTeamsService added in v0.11.0 

type MicrosoftTeamsService struct {
	Service
	Properties *MicrosoftTeamsServiceProperties `json:"properties"`
}

MicrosoftTeamsService represents Microsoft Teams service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#microsoft-teams-notifications

type MicrosoftTeamsServiceProperties added in v0.11.0 

type MicrosoftTeamsServiceProperties struct {
	WebHook                   string    `json:"webhook"`
	NotifyOnlyBrokenPipelines BoolValue `json:"notify_only_broken_pipelines"`
	BranchesToBeNotified      string    `json:"branches_to_be_notified"`
	IssuesEvents              BoolValue `json:"issues_events"`
	ConfidentialIssuesEvents  BoolValue `json:"confidential_issues_events"`
	MergeRequestsEvents       BoolValue `json:"merge_requests_events"`
	TagPushEvents             BoolValue `json:"tag_push_events"`
	NoteEvents                BoolValue `json:"note_events"`
	ConfidentialNoteEvents    BoolValue `json:"confidential_note_events"`
	PipelineEvents            BoolValue `json:"pipeline_events"`
	WikiPageEvents            BoolValue `json:"wiki_page_events"`
}

MicrosoftTeamsServiceProperties represents Microsoft Teams specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#microsoft-teams-notifications

type Milestone 

type Milestone struct {
	ID          int64      `json:"id"`
	IID         int64      `json:"iid"`
	GroupID     int64      `json:"group_id"`
	ProjectID   int64      `json:"project_id"`
	Title       string     `json:"title"`
	Description string     `json:"description"`
	StartDate   *ISOTime   `json:"start_date"`
	DueDate     *ISOTime   `json:"due_date"`
	State       string     `json:"state"`
	WebURL      string     `json:"web_url"`
	UpdatedAt   *time.Time `json:"updated_at"`
	CreatedAt   *time.Time `json:"created_at"`
	Expired     *bool      `json:"expired"`
}

Milestone represents a GitLab milestone.

GitLab API docs: https://docs.gitlab.com/api/milestones/

func (Milestone) String 

func (m Milestone) String() string

type MilestoneEvent added in v0.116.0 

type MilestoneEvent struct {
	ID           int64      `json:"id"`
	User         *BasicUser `json:"user"`
	CreatedAt    *time.Time `json:"created_at"`
	ResourceType string     `json:"resource_type"`
	ResourceID   int64      `json:"resource_id"`
	Milestone    *Milestone `json:"milestone"`
	Action       string     `json:"action"`
}

MilestoneEvent represents a resource milestone event.

GitLab API docs: https://docs.gitlab.com/api/resource_milestone_events/

type MilestoneEventGroup added in v1.31.0 

type MilestoneEventGroup struct {
	GroupID   int64  `json:"group_id"`
	GroupName string `json:"group_name"`
	GroupPath string `json:"group_path"`
	FullPath  string `json:"full_path"`
}

MilestoneEventGroup represents a group in a milestone event.

type MilestoneEventObjectAttributes added in v1.20.0 

type MilestoneEventObjectAttributes struct {
	ID          int64    `json:"id"`
	IID         int64    `json:"iid"`
	Title       string   `json:"title"`
	Description string   `json:"description"`
	State       string   `json:"state"`
	CreatedAt   string   `json:"created_at"`
	UpdatedAt   string   `json:"updated_at"`
	DueDate     *ISOTime `json:"due_date"`
	StartDate   *ISOTime `json:"start_date"`
	GroupID     *int64   `json:"group_id"`
	ProjectID   int64    `json:"project_id"`
}

type MilestoneEventProject added in v1.20.0 

type MilestoneEventProject struct {
	ID                int64  `json:"id"`
	Name              string `json:"name"`
	Description       string `json:"description"`
	WebURL            string `json:"web_url"`
	AvatarURL         string `json:"avatar_url"`
	GitSSHURL         string `json:"git_ssh_url"`
	GitHTTPURL        string `json:"git_http_url"`
	Namespace         string `json:"namespace"`
	VisibilityLevel   int64  `json:"visibility_level"`
	PathWithNamespace string `json:"path_with_namespace"`
	DefaultBranch     string `json:"default_branch"`
	CIConfigPath      string `json:"ci_config_path"`
	Homepage          string `json:"homepage"`
	URL               string `json:"url"`
	SSHURL            string `json:"ssh_url"`
	HTTPURL           string `json:"http_url"`
}

MilestoneEventProject represents a project in a milestone event.

type MilestoneWebhookEvent added in v1.20.0 

type MilestoneWebhookEvent struct {
	ObjectKind       string                         `json:"object_kind"`
	EventType        string                         `json:"event_type"`
	Project          MilestoneEventProject          `json:"project"`
	Group            *MilestoneEventGroup           `json:"group,omitempty"`
	ObjectAttributes MilestoneEventObjectAttributes `json:"object_attributes"`
	Action           string                         `json:"action"`
}

MilestoneWebhookEvent represents a milestone webhook event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#milestone-events

type MilestonesService 

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

MilestonesService handles communication with the milestone related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/milestones/

func (*MilestonesService) CreateMilestone 

func (s *MilestonesService) CreateMilestone(pid any, opt *CreateMilestoneOptions, options ...RequestOptionFunc) (*Milestone, *Response, error)

func (*MilestonesService) DeleteMilestone added in v0.10.0 

func (s *MilestonesService) DeleteMilestone(pid any, milestone int64, options ...RequestOptionFunc) (*Response, error)

func (*MilestonesService) GetMilestone 

func (s *MilestonesService) GetMilestone(pid any, milestone int64, options ...RequestOptionFunc) (*Milestone, *Response, error)

func (*MilestonesService) GetMilestoneIssues 

func (s *MilestonesService) GetMilestoneIssues(pid any, milestone int64, opt *GetMilestoneIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)

func (*MilestonesService) GetMilestoneMergeRequests added in v0.10.0 

func (s *MilestonesService) GetMilestoneMergeRequests(pid any, milestone int64, opt *GetMilestoneMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)

func (*MilestonesService) ListMilestones 

func (s *MilestonesService) ListMilestones(pid any, opt *ListMilestonesOptions, options ...RequestOptionFunc) ([]*Milestone, *Response, error)

func (*MilestonesService) UpdateMilestone 

func (s *MilestonesService) UpdateMilestone(pid any, milestone int64, opt *UpdateMilestoneOptions, options ...RequestOptionFunc) (*Milestone, *Response, error)

type MilestonesServiceInterface added in v0.126.0 

type MilestonesServiceInterface interface {
	// ListMilestones returns a list of project milestones.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/milestones/#list-project-milestones
	ListMilestones(pid any, opt *ListMilestonesOptions, options ...RequestOptionFunc) ([]*Milestone, *Response, error)
	// GetMilestone gets a single project milestone.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/milestones/#get-single-milestone
	GetMilestone(pid any, milestone int64, options ...RequestOptionFunc) (*Milestone, *Response, error)
	// CreateMilestone creates a new project milestone.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/milestones/#create-new-milestone
	CreateMilestone(pid any, opt *CreateMilestoneOptions, options ...RequestOptionFunc) (*Milestone, *Response, error)
	// UpdateMilestone updates an existing project milestone.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/milestones/#edit-milestone
	UpdateMilestone(pid any, milestone int64, opt *UpdateMilestoneOptions, options ...RequestOptionFunc) (*Milestone, *Response, error)
	// DeleteMilestone deletes a specified project milestone.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/milestones/#delete-project-milestone
	DeleteMilestone(pid any, milestone int64, options ...RequestOptionFunc) (*Response, error)
	// GetMilestoneIssues gets all issues assigned to a single project milestone.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/milestones/#get-all-issues-assigned-to-a-single-milestone
	GetMilestoneIssues(pid any, milestone int64, opt *GetMilestoneIssuesOptions, options ...RequestOptionFunc) ([]*Issue, *Response, error)
	// GetMilestoneMergeRequests gets all merge requests assigned to a single
	// project milestone.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/milestones/#get-all-merge-requests-assigned-to-a-single-milestone
	GetMilestoneMergeRequests(pid any, milestone int64, opt *GetMilestoneMergeRequestsOptions, options ...RequestOptionFunc) ([]*BasicMergeRequest, *Response, error)
}

type ModelRegistryService added in v0.152.0 

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

ModelRegistryService handles communication with the model registry related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/model_registry/

func (*ModelRegistryService) DownloadMachineLearningModelPackage added in v0.152.0 

func (s *ModelRegistryService) DownloadMachineLearningModelPackage(pid, modelVersionID any, path string, filename string, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)

DownloadMachineLearningModelPackage downloads a machine learning model package file.

GitLab API docs: https://docs.gitlab.com/api/model_registry/#download-a-model-package-file

type ModelRegistryServiceInterface added in v0.152.0 

type ModelRegistryServiceInterface interface {
	DownloadMachineLearningModelPackage(pid, modelVersionID any, path string, filename string, options ...RequestOptionFunc) (*bytes.Reader, *Response, error)
}

type ModifyUserOptions 

type ModifyUserOptions struct {
	Admin               *bool       `url:"admin,omitempty" json:"admin,omitempty"`
	Avatar              *UserAvatar `url:"-" json:"avatar,omitempty"`
	Bio                 *string     `url:"bio,omitempty" json:"bio,omitempty"`
	CanCreateGroup      *bool       `url:"can_create_group,omitempty" json:"can_create_group,omitempty"`
	CommitEmail         *string     `url:"commit_email,omitempty" json:"commit_email,omitempty"`
	Email               *string     `url:"email,omitempty" json:"email,omitempty"`
	External            *bool       `url:"external,omitempty" json:"external,omitempty"`
	ExternUID           *string     `url:"extern_uid,omitempty" json:"extern_uid,omitempty"`
	JobTitle            *string     `url:"job_title,omitempty" json:"job_title,omitempty"`
	Linkedin            *string     `url:"linkedin,omitempty" json:"linkedin,omitempty"`
	Location            *string     `url:"location,omitempty" json:"location,omitempty"`
	Name                *string     `url:"name,omitempty" json:"name,omitempty"`
	Note                *string     `url:"note,omitempty" json:"note,omitempty"`
	Organization        *string     `url:"organization,omitempty" json:"organization,omitempty"`
	Password            *string     `url:"password,omitempty" json:"password,omitempty"`
	PrivateProfile      *bool       `url:"private_profile,omitempty" json:"private_profile,omitempty"`
	ProjectsLimit       *int64      `url:"projects_limit,omitempty" json:"projects_limit,omitempty"`
	Provider            *string     `url:"provider,omitempty" json:"provider,omitempty"`
	PublicEmail         *string     `url:"public_email,omitempty" json:"public_email,omitempty"`
	SkipReconfirmation  *bool       `url:"skip_reconfirmation,omitempty" json:"skip_reconfirmation,omitempty"`
	Skype               *string     `url:"skype,omitempty" json:"skype,omitempty"`
	ThemeID             *int64      `url:"theme_id,omitempty" json:"theme_id,omitempty"`
	Twitter             *string     `url:"twitter,omitempty" json:"twitter,omitempty"`
	Username            *string     `url:"username,omitempty" json:"username,omitempty"`
	WebsiteURL          *string     `url:"website_url,omitempty" json:"website_url,omitempty"`
	ViewDiffsFileByFile *bool       `url:"view_diffs_file_by_file,omitempty" json:"view_diffs_file_by_file,omitempty"`
}

ModifyUserOptions represents the available ModifyUser() options.

GitLab API docs: https://docs.gitlab.com/api/users/#modify-a-user

type MoveIssueOptions added in v0.116.0 

type MoveIssueOptions struct {
	ToProjectID *int64 `url:"to_project_id,omitempty" json:"to_project_id,omitempty"`
}

MoveIssueOptions represents the available MoveIssue() options.

GitLab API docs: https://docs.gitlab.com/api/issues/#move-an-issue

type Namespace 

type Namespace struct {
	ID                          int64    `json:"id"`
	Name                        string   `json:"name"`
	Path                        string   `json:"path"`
	Kind                        string   `json:"kind"`
	FullPath                    string   `json:"full_path"`
	ParentID                    int64    `json:"parent_id"`
	AvatarURL                   *string  `json:"avatar_url"`
	WebURL                      string   `json:"web_url"`
	MembersCountWithDescendants int64    `json:"members_count_with_descendants"`
	BillableMembersCount        int64    `json:"billable_members_count"`
	Plan                        string   `json:"plan"`
	TrialEndsOn                 *ISOTime `json:"trial_ends_on"`
	Trial                       bool     `json:"trial"`
	MaxSeatsUsed                *int64   `json:"max_seats_used"`
	SeatsInUse                  *int64   `json:"seats_in_use"`
}

Namespace represents a GitLab namespace.

GitLab API docs: https://docs.gitlab.com/api/namespaces/

func (Namespace) String 

func (n Namespace) String() string

type NamespaceExistance added in v0.116.0 

type NamespaceExistance struct {
	Exists   bool     `json:"exists"`
	Suggests []string `json:"suggests"`
}

NamespaceExistance represents a namespace exists result.

GitLab API docs: https://docs.gitlab.com/api/namespaces/#verify-namespace-availability

type NamespaceExistsOptions added in v0.116.0 

type NamespaceExistsOptions struct {
	ParentID *int64 `url:"parent_id,omitempty" json:"parent_id,omitempty"`
}

NamespaceExistsOptions represents the available NamespaceExists() options.

GitLab API docs: https://docs.gitlab.com/api/namespaces/#verify-namespace-availability

type NamespacesService 

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

NamespacesService handles communication with the namespace related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/namespaces/

func (*NamespacesService) GetNamespace added in v0.7.4 

func (s *NamespacesService) GetNamespace(id any, options ...RequestOptionFunc) (*Namespace, *Response, error)

GetNamespace gets a namespace by id.

GitLab API docs: https://docs.gitlab.com/api/namespaces/#get-details-on-a-namespace

func (*NamespacesService) ListNamespaces 

func (s *NamespacesService) ListNamespaces(opt *ListNamespacesOptions, options ...RequestOptionFunc) ([]*Namespace, *Response, error)

ListNamespaces gets a list of projects accessible by the authenticated user.

GitLab API docs: https://docs.gitlab.com/api/namespaces/#list-all-namespaces

func (*NamespacesService) NamespaceExists added in v0.116.0 

func (s *NamespacesService) NamespaceExists(id any, opt *NamespaceExistsOptions, options ...RequestOptionFunc) (*NamespaceExistance, *Response, error)

NamespaceExists checks the existence of a namespace.

GitLab API docs: https://docs.gitlab.com/api/namespaces/#verify-namespace-availability

func (*NamespacesService) SearchNamespace 

func (s *NamespacesService) SearchNamespace(query string, options ...RequestOptionFunc) ([]*Namespace, *Response, error)

SearchNamespace gets all namespaces that match your string in their name or path.

GitLab API docs: https://docs.gitlab.com/api/namespaces/#list-all-namespaces

type NamespacesServiceInterface added in v0.126.0 

type NamespacesServiceInterface interface {
	ListNamespaces(opt *ListNamespacesOptions, options ...RequestOptionFunc) ([]*Namespace, *Response, error)
	SearchNamespace(query string, options ...RequestOptionFunc) ([]*Namespace, *Response, error)
	GetNamespace(id any, options ...RequestOptionFunc) (*Namespace, *Response, error)
	NamespaceExists(id any, opt *NamespaceExistsOptions, options ...RequestOptionFunc) (*NamespaceExistance, *Response, error)
}

type NewMembersCount added in v0.128.0 

type NewMembersCount struct {
	NewMembersCount int64 `url:"new_members_count" json:"new_members_count"`
}

NewMembersCount represents the total count of recently added members to a group.

GitLab API docs: https://docs.gitlab.com/api/group_activity_analytics/#get-count-of-members-recently-added-to-group

type NoEscape added in v1.3.0 

type NoEscape struct {
	Value string
}

type Note 

type Note struct {
	ID           int64          `json:"id"`
	Type         NoteTypeValue  `json:"type"`
	Body         string         `json:"body"`
	Attachment   string         `json:"attachment"`
	Title        string         `json:"title"`
	FileName     string         `json:"file_name"`
	Author       NoteAuthor     `json:"author"`
	System       bool           `json:"system"`
	CreatedAt    *time.Time     `json:"created_at"`
	UpdatedAt    *time.Time     `json:"updated_at"`
	ExpiresAt    *time.Time     `json:"expires_at"`
	CommitID     string         `json:"commit_id"`
	Position     *NotePosition  `json:"position"`
	NoteableID   int64          `json:"noteable_id"`
	NoteableType string         `json:"noteable_type"`
	ProjectID    int64          `json:"project_id"`
	NoteableIID  int64          `json:"noteable_iid"`
	Resolvable   bool           `json:"resolvable"`
	Resolved     bool           `json:"resolved"`
	ResolvedAt   *time.Time     `json:"resolved_at"`
	ResolvedBy   NoteResolvedBy `json:"resolved_by"`
	Internal     bool           `json:"internal"`

	// Deprecated: use Internal instead
	Confidential bool `json:"confidential"`
}

Note represents a GitLab note.

GitLab API docs: https://docs.gitlab.com/api/notes/

func (Note) String 

func (n Note) String() string

type NoteAuthor added in v0.124.0 

type NoteAuthor struct {
	ID        int64  `json:"id"`
	Username  string `json:"username"`
	Email     string `json:"email"`
	Name      string `json:"name"`
	State     string `json:"state"`
	AvatarURL string `json:"avatar_url"`
	WebURL    string `json:"web_url"`
}

NoteAuthor represents the author of a note.

type NotePosition added in v0.11.2 

type NotePosition struct {
	BaseSHA      string     `json:"base_sha"`
	StartSHA     string     `json:"start_sha"`
	HeadSHA      string     `json:"head_sha"`
	PositionType string     `json:"position_type"`
	NewPath      string     `json:"new_path,omitempty"`
	NewLine      int64      `json:"new_line,omitempty"`
	OldPath      string     `json:"old_path,omitempty"`
	OldLine      int64      `json:"old_line,omitempty"`
	LineRange    *LineRange `json:"line_range,omitempty"`
}

NotePosition represents the position attributes of a note.

type NoteResolvedBy added in v1.0.0 

type NoteResolvedBy struct {
	ID        int64  `json:"id"`
	Username  string `json:"username"`
	Email     string `json:"email"`
	Name      string `json:"name"`
	State     string `json:"state"`
	AvatarURL string `json:"avatar_url"`
	WebURL    string `json:"web_url"`
}

NoteResolvedBy represents the resolver of a GitLab note.

GitLab API docs: https://docs.gitlab.com/api/notes/

type NoteTypeValue added in v0.116.0 

type NoteTypeValue string

NoteTypeValue represents the type of a Note. 

const (
	DiffNote       NoteTypeValue = "DiffNote"
	DiscussionNote NoteTypeValue = "DiscussionNote"
	GenericNote    NoteTypeValue = "Note"
	LegacyDiffNote NoteTypeValue = "LegacyDiffNote"
)

List of available note types.

type NotesService 

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

NotesService handles communication with the notes related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/notes/

func (*NotesService) CreateEpicNote added in v0.116.0 

func (s *NotesService) CreateEpicNote(gid any, epic int64, opt *CreateEpicNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

CreateEpicNote creates a new note for a single merge request. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/notes/#create-new-epic-note

func (*NotesService) CreateIssueNote 

func (s *NotesService) CreateIssueNote(pid any, issue int64, opt *CreateIssueNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

CreateIssueNote creates a new note to a single project issue.

GitLab API docs: https://docs.gitlab.com/api/notes/#create-new-issue-note

func (*NotesService) CreateMergeRequestNote 

func (s *NotesService) CreateMergeRequestNote(pid any, mergeRequest int64, opt *CreateMergeRequestNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

CreateMergeRequestNote creates a new note for a single merge request.

GitLab API docs: https://docs.gitlab.com/api/notes/#create-new-merge-request-note

func (*NotesService) CreateSnippetNote 

func (s *NotesService) CreateSnippetNote(pid any, snippet int64, opt *CreateSnippetNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

CreateSnippetNote creates a new note for a single snippet. Snippet notes are comments users can post to a snippet.

GitLab API docs: https://docs.gitlab.com/api/notes/#create-new-snippet-note

func (*NotesService) DeleteEpicNote added in v0.116.0 

func (s *NotesService) DeleteEpicNote(gid any, epic, note int64, options ...RequestOptionFunc) (*Response, error)

DeleteEpicNote deletes an existing note of a merge request. Will be removed in v5 of the API, use Work Items API instead

https://docs.gitlab.com/api/notes/#delete-an-epic-note

func (*NotesService) DeleteIssueNote added in v0.6.0 

func (s *NotesService) DeleteIssueNote(pid any, issue, note int64, options ...RequestOptionFunc) (*Response, error)

DeleteIssueNote deletes an existing note of an issue.

GitLab API docs: https://docs.gitlab.com/api/notes/#delete-an-issue-note

func (*NotesService) DeleteMergeRequestNote added in v0.6.0 

func (s *NotesService) DeleteMergeRequestNote(pid any, mergeRequest, note int64, options ...RequestOptionFunc) (*Response, error)

DeleteMergeRequestNote deletes an existing note of a merge request.

GitLab API docs: https://docs.gitlab.com/api/notes/#delete-a-merge-request-note

func (*NotesService) DeleteSnippetNote added in v0.6.0 

func (s *NotesService) DeleteSnippetNote(pid any, snippet, note int64, options ...RequestOptionFunc) (*Response, error)

DeleteSnippetNote deletes an existing note of a snippet.

GitLab API docs: https://docs.gitlab.com/api/notes/#delete-a-snippet-note

func (*NotesService) GetEpicNote added in v0.116.0 

func (s *NotesService) GetEpicNote(gid any, epic, note int64, options ...RequestOptionFunc) (*Note, *Response, error)

GetEpicNote returns a single note for an epic. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/notes/#get-single-epic-note

func (*NotesService) GetIssueNote 

func (s *NotesService) GetIssueNote(pid any, issue, note int64, options ...RequestOptionFunc) (*Note, *Response, error)

GetIssueNote returns a single note for a specific project issue.

GitLab API docs: https://docs.gitlab.com/api/notes/#get-single-issue-note

func (*NotesService) GetMergeRequestNote 

func (s *NotesService) GetMergeRequestNote(pid any, mergeRequest, note int64, options ...RequestOptionFunc) (*Note, *Response, error)

GetMergeRequestNote returns a single note for a given merge request.

GitLab API docs: https://docs.gitlab.com/api/notes/#get-single-merge-request-note

func (*NotesService) GetSnippetNote 

func (s *NotesService) GetSnippetNote(pid any, snippet, note int64, options ...RequestOptionFunc) (*Note, *Response, error)

GetSnippetNote returns a single note for a given snippet.

GitLab API docs: https://docs.gitlab.com/api/notes/#get-single-snippet-note

func (*NotesService) ListEpicNotes added in v0.116.0 

func (s *NotesService) ListEpicNotes(gid any, epic int64, opt *ListEpicNotesOptions, options ...RequestOptionFunc) ([]*Note, *Response, error)

ListEpicNotes gets a list of all notes for a single epic. Will be removed in v5 of the API, use Work Items API instead

GitLab API docs: https://docs.gitlab.com/api/notes/#list-all-epic-notes

func (*NotesService) ListIssueNotes 

func (s *NotesService) ListIssueNotes(pid any, issue int64, opt *ListIssueNotesOptions, options ...RequestOptionFunc) ([]*Note, *Response, error)

ListIssueNotes gets a list of all notes for a single issue.

GitLab API docs: https://docs.gitlab.com/api/notes/#list-project-issue-notes

func (*NotesService) ListMergeRequestNotes 

func (s *NotesService) ListMergeRequestNotes(pid any, mergeRequest int64, opt *ListMergeRequestNotesOptions, options ...RequestOptionFunc) ([]*Note, *Response, error)

ListMergeRequestNotes gets a list of all notes for a single merge request.

GitLab API docs: https://docs.gitlab.com/api/notes/#list-all-merge-request-notes

func (*NotesService) ListSnippetNotes 

func (s *NotesService) ListSnippetNotes(pid any, snippet int64, opt *ListSnippetNotesOptions, options ...RequestOptionFunc) ([]*Note, *Response, error)

ListSnippetNotes gets a list of all notes for a single snippet. Snippet notes are comments users can post to a snippet.

GitLab API docs: https://docs.gitlab.com/api/notes/#list-all-snippet-notes

func (*NotesService) UpdateEpicNote added in v0.116.0 

func (s *NotesService) UpdateEpicNote(gid any, epic, note int64, opt *UpdateEpicNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

UpdateEpicNote modifies existing note of an epic. Will be removed in v5 of the API, use Work Items API instead

https://docs.gitlab.com/api/notes/#modify-existing-epic-note

func (*NotesService) UpdateIssueNote 

func (s *NotesService) UpdateIssueNote(pid any, issue, note int64, opt *UpdateIssueNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

UpdateIssueNote modifies existing note of an issue.

GitLab API docs: https://docs.gitlab.com/api/notes/#modify-existing-issue-note

func (*NotesService) UpdateMergeRequestNote 

func (s *NotesService) UpdateMergeRequestNote(pid any, mergeRequest, note int64, opt *UpdateMergeRequestNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

UpdateMergeRequestNote modifies existing note of a merge request.

GitLab API docs: https://docs.gitlab.com/api/notes/#modify-existing-merge-request-note

func (*NotesService) UpdateSnippetNote 

func (s *NotesService) UpdateSnippetNote(pid any, snippet, note int64, opt *UpdateSnippetNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)

UpdateSnippetNote modifies existing note of a snippet.

GitLab API docs: https://docs.gitlab.com/api/notes/#modify-existing-snippet-note

type NotesServiceInterface added in v0.126.0 

type NotesServiceInterface interface {
	ListIssueNotes(pid any, issue int64, opt *ListIssueNotesOptions, options ...RequestOptionFunc) ([]*Note, *Response, error)
	GetIssueNote(pid any, issue, note int64, options ...RequestOptionFunc) (*Note, *Response, error)
	CreateIssueNote(pid any, issue int64, opt *CreateIssueNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)
	UpdateIssueNote(pid any, issue, note int64, opt *UpdateIssueNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)
	DeleteIssueNote(pid any, issue, note int64, options ...RequestOptionFunc) (*Response, error)
	ListSnippetNotes(pid any, snippet int64, opt *ListSnippetNotesOptions, options ...RequestOptionFunc) ([]*Note, *Response, error)
	GetSnippetNote(pid any, snippet, note int64, options ...RequestOptionFunc) (*Note, *Response, error)
	CreateSnippetNote(pid any, snippet int64, opt *CreateSnippetNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)
	UpdateSnippetNote(pid any, snippet, note int64, opt *UpdateSnippetNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)
	DeleteSnippetNote(pid any, snippet, note int64, options ...RequestOptionFunc) (*Response, error)
	ListMergeRequestNotes(pid any, mergeRequest int64, opt *ListMergeRequestNotesOptions, options ...RequestOptionFunc) ([]*Note, *Response, error)
	GetMergeRequestNote(pid any, mergeRequest, note int64, options ...RequestOptionFunc) (*Note, *Response, error)
	CreateMergeRequestNote(pid any, mergeRequest int64, opt *CreateMergeRequestNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)
	UpdateMergeRequestNote(pid any, mergeRequest, note int64, opt *UpdateMergeRequestNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)
	DeleteMergeRequestNote(pid any, mergeRequest, note int64, options ...RequestOptionFunc) (*Response, error)
	ListEpicNotes(gid any, epic int64, opt *ListEpicNotesOptions, options ...RequestOptionFunc) ([]*Note, *Response, error)
	GetEpicNote(gid any, epic, note int64, options ...RequestOptionFunc) (*Note, *Response, error)
	CreateEpicNote(gid any, epic int64, opt *CreateEpicNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)
	UpdateEpicNote(gid any, epic, note int64, opt *UpdateEpicNoteOptions, options ...RequestOptionFunc) (*Note, *Response, error)
	DeleteEpicNote(gid any, epic, note int64, options ...RequestOptionFunc) (*Response, error)
}

type NotificationEvents added in v0.4.0 

type NotificationEvents struct {
	CloseIssue                bool `json:"close_issue"`
	CloseMergeRequest         bool `json:"close_merge_request"`
	FailedPipeline            bool `json:"failed_pipeline"`
	FixedPipeline             bool `json:"fixed_pipeline"`
	IssueDue                  bool `json:"issue_due"`
	MergeWhenPipelineSucceeds bool `json:"merge_when_pipeline_succeeds"`
	MergeMergeRequest         bool `json:"merge_merge_request"`
	MovedProject              bool `json:"moved_project"`
	NewIssue                  bool `json:"new_issue"`
	NewMergeRequest           bool `json:"new_merge_request"`
	NewEpic                   bool `json:"new_epic"`
	NewNote                   bool `json:"new_note"`
	PushToMergeRequest        bool `json:"push_to_merge_request"`
	ReassignIssue             bool `json:"reassign_issue"`
	ReassignMergeRequest      bool `json:"reassign_merge_request"`
	ReopenIssue               bool `json:"reopen_issue"`
	ReopenMergeRequest        bool `json:"reopen_merge_request"`
	SuccessPipeline           bool `json:"success_pipeline"`
}

NotificationEvents represents the available notification setting events.

GitLab API docs: https://docs.gitlab.com/api/notification_settings/#valid-notification-levels

type NotificationLevelValue added in v0.2.0 

type NotificationLevelValue int

NotificationLevelValue represents a notification level. 

const (
	DisabledNotificationLevel NotificationLevelValue = iota
	ParticipatingNotificationLevel
	WatchNotificationLevel
	GlobalNotificationLevel
	MentionNotificationLevel
	CustomNotificationLevel
)

List of valid notification levels.

func (NotificationLevelValue) MarshalJSON added in v0.4.0 

func (l NotificationLevelValue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (NotificationLevelValue) String added in v0.4.0 

func (l NotificationLevelValue) String() string

String implements the fmt.Stringer interface.

func (*NotificationLevelValue) UnmarshalJSON added in v0.4.0 

func (l *NotificationLevelValue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type NotificationSettings added in v0.4.0 

type NotificationSettings struct {
	Level             NotificationLevelValue `json:"level"`
	NotificationEmail string                 `json:"notification_email"`
	Events            *NotificationEvents    `json:"events"`
}

NotificationSettings represents the GitLab notification setting.

GitLab API docs: https://docs.gitlab.com/api/notification_settings/#valid-notification-levels

func (NotificationSettings) String added in v0.4.0 

func (ns NotificationSettings) String() string

type NotificationSettingsOptions added in v0.4.0 

type NotificationSettingsOptions struct {
	Level                     *NotificationLevelValue `url:"level,omitempty" json:"level,omitempty"`
	NotificationEmail         *string                 `url:"notification_email,omitempty" json:"notification_email,omitempty"`
	CloseIssue                *bool                   `url:"close_issue,omitempty" json:"close_issue,omitempty"`
	CloseMergeRequest         *bool                   `url:"close_merge_request,omitempty" json:"close_merge_request,omitempty"`
	FailedPipeline            *bool                   `url:"failed_pipeline,omitempty" json:"failed_pipeline,omitempty"`
	FixedPipeline             *bool                   `url:"fixed_pipeline,omitempty" json:"fixed_pipeline,omitempty"`
	IssueDue                  *bool                   `url:"issue_due,omitempty" json:"issue_due,omitempty"`
	MergeMergeRequest         *bool                   `url:"merge_merge_request,omitempty" json:"merge_merge_request,omitempty"`
	MergeWhenPipelineSucceeds *bool                   `url:"merge_when_pipeline_succeeds,omitempty" json:"merge_when_pipeline_succeeds,omitempty"`
	MovedProject              *bool                   `url:"moved_project,omitempty" json:"moved_project,omitempty"`
	NewEpic                   *bool                   `url:"new_epic,omitempty" json:"new_epic,omitempty"`
	NewIssue                  *bool                   `url:"new_issue,omitempty" json:"new_issue,omitempty"`
	NewMergeRequest           *bool                   `url:"new_merge_request,omitempty" json:"new_merge_request,omitempty"`
	NewNote                   *bool                   `url:"new_note,omitempty" json:"new_note,omitempty"`
	PushToMergeRequest        *bool                   `url:"push_to_merge_request,omitempty" json:"push_to_merge_request,omitempty"`
	ReassignIssue             *bool                   `url:"reassign_issue,omitempty" json:"reassign_issue,omitempty"`
	ReassignMergeRequest      *bool                   `url:"reassign_merge_request,omitempty" json:"reassign_merge_request,omitempty"`
	ReopenIssue               *bool                   `url:"reopen_issue,omitempty" json:"reopen_issue,omitempty"`
	ReopenMergeRequest        *bool                   `url:"reopen_merge_request,omitempty" json:"reopen_merge_request,omitempty"`
	SuccessPipeline           *bool                   `url:"success_pipeline,omitempty" json:"success_pipeline,omitempty"`
}

NotificationSettingsOptions represents the available options that can be passed to the API when updating the notification settings.

type NotificationSettingsService added in v0.4.0 

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

NotificationSettingsService handles communication with the notification settings related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/notification_settings/

func (*NotificationSettingsService) GetGlobalSettings added in v0.4.0 

func (s *NotificationSettingsService) GetGlobalSettings(options ...RequestOptionFunc) (*NotificationSettings, *Response, error)

func (*NotificationSettingsService) GetSettingsForGroup added in v0.4.0 

func (s *NotificationSettingsService) GetSettingsForGroup(gid any, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)

func (*NotificationSettingsService) GetSettingsForProject added in v0.4.0 

func (s *NotificationSettingsService) GetSettingsForProject(pid any, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)

func (*NotificationSettingsService) UpdateGlobalSettings added in v0.4.0 

func (s *NotificationSettingsService) UpdateGlobalSettings(opt *NotificationSettingsOptions, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)

func (*NotificationSettingsService) UpdateSettingsForGroup added in v0.4.0 

func (s *NotificationSettingsService) UpdateSettingsForGroup(gid any, opt *NotificationSettingsOptions, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)

func (*NotificationSettingsService) UpdateSettingsForProject added in v0.4.0 

func (s *NotificationSettingsService) UpdateSettingsForProject(pid any, opt *NotificationSettingsOptions, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)

type NotificationSettingsServiceInterface added in v0.126.0 

type NotificationSettingsServiceInterface interface {
	// GetGlobalSettings returns current notification settings and email address.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/notification_settings/#global-notification-settings
	GetGlobalSettings(options ...RequestOptionFunc) (*NotificationSettings, *Response, error)
	// UpdateGlobalSettings updates current notification settings and email address.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/notification_settings/#update-global-notification-settings
	UpdateGlobalSettings(opt *NotificationSettingsOptions, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)
	// GetSettingsForGroup returns current group notification settings.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/notification_settings/#group--project-level-notification-settings
	GetSettingsForGroup(gid any, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)
	// GetSettingsForProject returns current project notification settings.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/notification_settings/#group--project-level-notification-settings
	GetSettingsForProject(pid any, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)
	// UpdateSettingsForGroup updates current group notification settings.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/notification_settings/#update-groupproject-level-notification-settings
	UpdateSettingsForGroup(gid any, opt *NotificationSettingsOptions, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)
	// UpdateSettingsForProject updates current project notification settings.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/notification_settings/#update-groupproject-level-notification-settings
	UpdateSettingsForProject(pid any, opt *NotificationSettingsOptions, options ...RequestOptionFunc) (*NotificationSettings, *Response, error)
}

type OAuthTokenSource added in v0.130.0 

type OAuthTokenSource struct {
	TokenSource oauth2.TokenSource
}

OAuthTokenSource wraps an oauth2.TokenSource to implement the AuthSource interface.

func (OAuthTokenSource) Header added in v0.130.0 

func (as OAuthTokenSource) Header(_ context.Context) (string, string, error)

func (OAuthTokenSource) Init added in v0.130.0 

func (OAuthTokenSource) Init(context.Context, *Client) error

type Package added in v0.116.0 

type Package struct {
	ID               int64         `json:"id"`
	Name             string        `json:"name"`
	Version          string        `json:"version"`
	PackageType      string        `json:"package_type"`
	Status           string        `json:"status"`
	Links            *PackageLinks `json:"_links"`
	CreatedAt        *time.Time    `json:"created_at"`
	LastDownloadedAt *time.Time    `json:"last_downloaded_at"`
	Tags             []PackageTag  `json:"tags"`
}

Package represents a GitLab package.

GitLab API docs: https://docs.gitlab.com/api/packages/

func (Package) String added in v0.116.0 

func (s Package) String() string

type PackageFile added in v0.116.0 

type PackageFile struct {
	ID         int64       `json:"id"`
	PackageID  int64       `json:"package_id"`
	CreatedAt  *time.Time  `json:"created_at"`
	FileName   string      `json:"file_name"`
	Size       int64       `json:"size"`
	FileMD5    string      `json:"file_md5"`
	FileSHA1   string      `json:"file_sha1"`
	FileSHA256 string      `json:"file_sha256"`
	Pipeline   *[]Pipeline `json:"pipelines"`
}

PackageFile represents one file contained within a package.

GitLab API docs: https://docs.gitlab.com/api/packages/

func (PackageFile) String added in v0.116.0 

func (s PackageFile) String() string
type PackageLinks struct {
	WebPath       string `json:"web_path"`
	DeleteAPIPath string `json:"delete_api_path"`
}

PackageLinks holds links for itself and deleting.

func (PackageLinks) String added in v0.116.0 

func (s PackageLinks) String() string

type PackageProtectionRule added in v0.154.0 

type PackageProtectionRule struct {
	ID                          int64  `json:"id"`
	ProjectID                   int64  `json:"project_id"`
	PackageNamePattern          string `json:"package_name_pattern"`
	PackageType                 string `json:"package_type"`
	MinimumAccessLevelForDelete string `json:"minimum_access_level_for_delete"`
	MinimumAccessLevelForPush   string `json:"minimum_access_level_for_push"`
}

PackageProtectionRule represents a GitLab package protection rule.

GitLab API docs: https://docs.gitlab.com/api/project_packages_protection_rules

type PackageTag added in v0.116.0 

type PackageTag struct {
	ID        int64      `json:"id"`
	PackageID int64      `json:"package_id"`
	Name      string     `json:"name"`
	CreatedAt *time.Time `json:"created_at"`
	UpdatedAt *time.Time `json:"updated_at"`
}

PackageTag holds label information about the package

func (PackageTag) String added in v0.116.0 

func (s PackageTag) String() string

type PackagesService added in v0.116.0 

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

PackagesService handles communication with the packages related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/packages/

func (*PackagesService) DeletePackageFile added in v0.116.0 

func (s *PackagesService) DeletePackageFile(pid any, pkg, file int64, options ...RequestOptionFunc) (*Response, error)

DeletePackageFile deletes a file in project package

GitLab API docs: https://docs.gitlab.com/api/packages/#delete-a-package-file

func (*PackagesService) DeleteProjectPackage added in v0.116.0 

func (s *PackagesService) DeleteProjectPackage(pid any, pkg int64, options ...RequestOptionFunc) (*Response, error)

DeleteProjectPackage deletes a package in a project.

GitLab API docs: https://docs.gitlab.com/api/packages/#delete-a-project-package

func (*PackagesService) ListGroupPackages added in v0.116.0 

func (s *PackagesService) ListGroupPackages(gid any, opt *ListGroupPackagesOptions, options ...RequestOptionFunc) ([]*GroupPackage, *Response, error)

ListGroupPackages gets a list of packages in a group.

GitLab API docs: https://docs.gitlab.com/api/packages/#for-a-group

func (*PackagesService) ListPackageFiles added in v0.116.0 

func (s *PackagesService) ListPackageFiles(pid any, pkg int64, opt *ListPackageFilesOptions, options ...RequestOptionFunc) ([]*PackageFile, *Response, error)

ListPackageFiles gets a list of files that are within a package

GitLab API docs: https://docs.gitlab.com/api/packages/#list-package-files

func (*PackagesService) ListProjectPackages added in v0.116.0 

func (s *PackagesService) ListProjectPackages(pid any, opt *ListProjectPackagesOptions, options ...RequestOptionFunc) ([]*Package, *Response, error)

ListProjectPackages gets a list of packages in a project.

GitLab API docs: https://docs.gitlab.com/api/packages/#for-a-project

type PackagesServiceInterface added in v0.126.0 

type PackagesServiceInterface interface {
	ListProjectPackages(pid any, opt *ListProjectPackagesOptions, options ...RequestOptionFunc) ([]*Package, *Response, error)
	ListGroupPackages(gid any, opt *ListGroupPackagesOptions, options ...RequestOptionFunc) ([]*GroupPackage, *Response, error)
	ListPackageFiles(pid any, pkg int64, opt *ListPackageFilesOptions, options ...RequestOptionFunc) ([]*PackageFile, *Response, error)
	DeleteProjectPackage(pid any, pkg int64, options ...RequestOptionFunc) (*Response, error)
	DeletePackageFile(pid any, pkg, file int64, options ...RequestOptionFunc) (*Response, error)
}

type PageInfo added in v1.34.0 

type PageInfo struct {
	EndCursor       string `json:"endCursor"`       // Cursor of the last item in this page (pass to "after" for next page)
	HasNextPage     bool   `json:"hasNextPage"`     // True if more items exist after this page
	StartCursor     string `json:"startCursor"`     // Cursor of the first item in this page (pass to "before" for previous page)
	HasPreviousPage bool   `json:"hasPreviousPage"` // True if items exist before this page
}

PageInfo contains cursor-based pagination metadata for GraphQL connections following the Relay cursor pagination specification. Use EndCursor and HasNextPage for forward pagination (most common), or StartCursor and HasPreviousPage for backward pagination.

Cursors are opaque strings that should not be parsed or constructed manually - always use the cursors returned by the API.

Note: GraphQL cursor pagination differs from GitLab's REST API keyset pagination. In REST, the pagination link points to the first item of the next page. In GraphQL, EndCursor points to the last item of the current page - you pass this to the "after" parameter to fetch items after it (essentially an off-by-one difference in semantics).

GitLab API docs: https://docs.gitlab.com/api/graphql/reference/#pageinfo

type Pages added in v0.116.0 

type Pages struct {
	URL                   string             `json:"url"`
	IsUniqueDomainEnabled bool               `json:"is_unique_domain_enabled"`
	ForceHTTPS            bool               `json:"force_https"`
	Deployments           []*PagesDeployment `json:"deployments"`
	PrimaryDomain         string             `json:"primary_domain"`
}

Pages represents the Pages of a project.

GitLab API docs: https://docs.gitlab.com/api/pages/

type PagesDeployment added in v0.116.0 

type PagesDeployment struct {
	CreatedAt     time.Time `json:"created_at"`
	URL           string    `json:"url"`
	PathPrefix    string    `json:"path_prefix"`
	RootDirectory string    `json:"root_directory"`
}

PagesDeployment represents a Pages deployment.

GitLab API docs: https://docs.gitlab.com/api/pages/

type PagesDomain added in v0.8.0 

type PagesDomain struct {
	Domain           string                 `json:"domain"`
	AutoSslEnabled   bool                   `json:"auto_ssl_enabled"`
	URL              string                 `json:"url"`
	ProjectID        int64                  `json:"project_id"`
	Verified         bool                   `json:"verified"`
	VerificationCode string                 `json:"verification_code"`
	EnabledUntil     *time.Time             `json:"enabled_until"`
	Certificate      PagesDomainCertificate `json:"certificate"`
}

PagesDomain represents a pages domain.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/

type PagesDomainCertificate added in v1.0.0 

type PagesDomainCertificate struct {
	Subject         string     `json:"subject"`
	Expired         bool       `json:"expired"`
	Expiration      *time.Time `json:"expiration"`
	Certificate     string     `json:"certificate"`
	CertificateText string     `json:"certificate_text"`
}

PagesDomainCertificate represents a pages domain certificate.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/

type PagesDomainsService added in v0.8.0 

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

PagesDomainsService handles communication with the pages domains related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/

func (*PagesDomainsService) CreatePagesDomain added in v0.8.0 

func (s *PagesDomainsService) CreatePagesDomain(pid any, opt *CreatePagesDomainOptions, options ...RequestOptionFunc) (*PagesDomain, *Response, error)

CreatePagesDomain creates a new project pages domain.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/#create-new-pages-domain

func (*PagesDomainsService) DeletePagesDomain added in v0.8.0 

func (s *PagesDomainsService) DeletePagesDomain(pid any, domain string, options ...RequestOptionFunc) (*Response, error)

DeletePagesDomain deletes an existing project pages domain.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/#delete-pages-domain

func (*PagesDomainsService) GetPagesDomain added in v0.8.0 

func (s *PagesDomainsService) GetPagesDomain(pid any, domain string, options ...RequestOptionFunc) (*PagesDomain, *Response, error)

GetPagesDomain get a specific pages domain for a project.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/#single-pages-domain

func (*PagesDomainsService) ListAllPagesDomains added in v0.11.2 

func (s *PagesDomainsService) ListAllPagesDomains(options ...RequestOptionFunc) ([]*PagesDomain, *Response, error)

ListAllPagesDomains gets a list of all pages domains.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/#list-all-pages-domains

func (*PagesDomainsService) ListPagesDomains added in v0.8.0 

func (s *PagesDomainsService) ListPagesDomains(pid any, opt *ListPagesDomainsOptions, options ...RequestOptionFunc) ([]*PagesDomain, *Response, error)

ListPagesDomains gets a list of project pages domains.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/#list-pages-domains

func (*PagesDomainsService) UpdatePagesDomain added in v0.8.0 

func (s *PagesDomainsService) UpdatePagesDomain(pid any, domain string, opt *UpdatePagesDomainOptions, options ...RequestOptionFunc) (*PagesDomain, *Response, error)

UpdatePagesDomain updates an existing project pages domain.

GitLab API docs: https://docs.gitlab.com/api/pages_domains/#update-pages-domain

type PagesDomainsServiceInterface added in v0.126.0 

type PagesDomainsServiceInterface interface {
	ListPagesDomains(pid any, opt *ListPagesDomainsOptions, options ...RequestOptionFunc) ([]*PagesDomain, *Response, error)
	ListAllPagesDomains(options ...RequestOptionFunc) ([]*PagesDomain, *Response, error)
	GetPagesDomain(pid any, domain string, options ...RequestOptionFunc) (*PagesDomain, *Response, error)
	CreatePagesDomain(pid any, opt *CreatePagesDomainOptions, options ...RequestOptionFunc) (*PagesDomain, *Response, error)
	UpdatePagesDomain(pid any, domain string, opt *UpdatePagesDomainOptions, options ...RequestOptionFunc) (*PagesDomain, *Response, error)
	DeletePagesDomain(pid any, domain string, options ...RequestOptionFunc) (*Response, error)
}

type PagesService added in v0.116.0 

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

PagesService handles communication with the pages related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/pages/

func (*PagesService) GetPages added in v0.116.0 

func (s *PagesService) GetPages(gid any, options ...RequestOptionFunc) (*Pages, *Response, error)

func (*PagesService) UnpublishPages added in v0.116.0 

func (s *PagesService) UnpublishPages(gid any, options ...RequestOptionFunc) (*Response, error)

func (*PagesService) UpdatePages added in v0.116.0 

func (s *PagesService) UpdatePages(pid any, opt UpdatePagesOptions, options ...RequestOptionFunc) (*Pages, *Response, error)

type PagesServiceInterface added in v0.126.0 

type PagesServiceInterface interface {
	// UnpublishPages unpublishes pages. The user must have admin privileges.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/pages/#unpublish-pages
	UnpublishPages(gid any, options ...RequestOptionFunc) (*Response, error)
	// GetPages lists Pages settings for a project. The user must have at least
	// maintainer privileges.
	//
	// GitLab API Docs:
	// https://docs.gitlab.com/api/pages/#get-pages-settings-for-a-project
	GetPages(gid any, options ...RequestOptionFunc) (*Pages, *Response, error)
	// UpdatePages updates Pages settings for a project. The user must have
	// administrator privileges.
	//
	// GitLab API Docs:
	// https://docs.gitlab.com/api/pages/#update-pages-settings-for-a-project
	UpdatePages(pid any, opt UpdatePagesOptions, options ...RequestOptionFunc) (*Pages, *Response, error)
}

type PaginationOptionFunc added in v0.128.0 

type PaginationOptionFunc = RequestOptionFunc

type PasswordCredentialsAuthSource added in v0.135.0 

type PasswordCredentialsAuthSource struct {
	Username string
	Password string

	AuthSource
}

PasswordCredentialsAuthSource implements the AuthSource interface for the OAuth 2.0 resource owner password credentials flow.

func (*PasswordCredentialsAuthSource) Init added in v0.135.0 

func (as *PasswordCredentialsAuthSource) Init(ctx context.Context, client *Client) error

type PatchProjectJobTokenAccessSettingsOptions added in v0.116.0 

type PatchProjectJobTokenAccessSettingsOptions struct {
	Enabled bool `json:"enabled"`
}

PatchProjectJobTokenAccessSettingsOptions represents the available PatchProjectJobTokenAccessSettings() options.

GitLab API docs: https://docs.gitlab.com/api/project_job_token_scopes/#patch-a-projects-cicd-job-token-access-settings

type Pather added in v0.160.1 

type Pather interface {
	// contains filtered or unexported methods
}

type PendingInvite added in v0.116.0 

type PendingInvite struct {
	ID            int64            `json:"id"`
	InviteEmail   string           `json:"invite_email"`
	CreatedAt     *time.Time       `json:"created_at"`
	AccessLevel   AccessLevelValue `json:"access_level"`
	ExpiresAt     *time.Time       `json:"expires_at"`
	UserName      string           `json:"user_name"`
	CreatedByName string           `json:"created_by_name"`
}

PendingInvite represents a pending invite.

GitLab API docs: https://docs.gitlab.com/api/invitations/

type Permissions 

type Permissions struct {
	ProjectAccess *ProjectAccess `json:"project_access"`
	GroupAccess   *GroupAccess   `json:"group_access"`
}

Permissions represents permissions.

type PersonalAccessToken added in v0.116.0 

type PersonalAccessToken struct {
	ID          int64      `json:"id"`
	Name        string     `json:"name"`
	Revoked     bool       `json:"revoked"`
	CreatedAt   *time.Time `json:"created_at"`
	Description string     `json:"description"`
	Scopes      []string   `json:"scopes"`
	UserID      int64      `json:"user_id"`
	LastUsedAt  *time.Time `json:"last_used_at,omitempty"`
	Active      bool       `json:"active"`
	ExpiresAt   *ISOTime   `json:"expires_at"`
	Token       string     `json:"token,omitempty"`
}

PersonalAccessToken represents a personal access token.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/

func (PersonalAccessToken) String added in v0.116.0 

func (p PersonalAccessToken) String() string

type PersonalAccessTokensService added in v0.116.0 

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

PersonalAccessTokensService handles communication with the personal access tokens related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/

func (*PersonalAccessTokensService) GetSinglePersonalAccessToken added in v0.116.0 

func (s *PersonalAccessTokensService) GetSinglePersonalAccessToken(options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)

GetSinglePersonalAccessToken get a single personal access token by using passing the token in a header.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/#self-inform

func (*PersonalAccessTokensService) GetSinglePersonalAccessTokenByID added in v0.116.0 

func (s *PersonalAccessTokensService) GetSinglePersonalAccessTokenByID(token int64, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)

GetSinglePersonalAccessTokenByID get a single personal access token by its ID.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/#get-details-on-a-personal-access-token

func (*PersonalAccessTokensService) ListPersonalAccessTokens added in v0.116.0 

func (s *PersonalAccessTokensService) ListPersonalAccessTokens(opt *ListPersonalAccessTokensOptions, options ...RequestOptionFunc) ([]*PersonalAccessToken, *Response, error)

ListPersonalAccessTokens gets a list of all personal access tokens.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/#list-all-personal-access-tokens

func (*PersonalAccessTokensService) RevokePersonalAccessToken added in v0.116.0 

func (s *PersonalAccessTokensService) RevokePersonalAccessToken(token int64, options ...RequestOptionFunc) (*Response, error)

RevokePersonalAccessToken is a backwards-compat shim for RevokePersonalAccessTokenByID. Deprecated: to be removed in 2.0; use RevokePersonalAccessTokenByID instead

func (*PersonalAccessTokensService) RevokePersonalAccessTokenByID added in v0.116.0 

func (s *PersonalAccessTokensService) RevokePersonalAccessTokenByID(token int64, options ...RequestOptionFunc) (*Response, error)

RevokePersonalAccessTokenByID revokes a personal access token by its ID.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/#revoke-a-personal-access-token

func (*PersonalAccessTokensService) RevokePersonalAccessTokenSelf added in v0.116.0 

func (s *PersonalAccessTokensService) RevokePersonalAccessTokenSelf(options ...RequestOptionFunc) (*Response, error)

RevokePersonalAccessTokenSelf revokes the currently authenticated personal access token.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/#self-revoke

func (*PersonalAccessTokensService) RotatePersonalAccessToken added in v0.116.0 

func (s *PersonalAccessTokensService) RotatePersonalAccessToken(token int64, opt *RotatePersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)

RotatePersonalAccessToken is a backwards-compat shim for RotatePersonalAccessTokenByID.

func (*PersonalAccessTokensService) RotatePersonalAccessTokenByID added in v0.116.0 

func (s *PersonalAccessTokensService) RotatePersonalAccessTokenByID(token int64, opt *RotatePersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)

RotatePersonalAccessTokenByID revokes a token and returns a new token that expires in one week per default.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/#rotate-a-personal-access-token

func (*PersonalAccessTokensService) RotatePersonalAccessTokenSelf added in v0.116.0 

func (s *PersonalAccessTokensService) RotatePersonalAccessTokenSelf(opt *RotatePersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)

RotatePersonalAccessTokenSelf revokes the currently authenticated token and returns a new token that expires in one week per default.

GitLab API docs: https://docs.gitlab.com/api/personal_access_tokens/#self-rotate

type PersonalAccessTokensServiceInterface added in v0.126.0 

type PersonalAccessTokensServiceInterface interface {
	ListPersonalAccessTokens(opt *ListPersonalAccessTokensOptions, options ...RequestOptionFunc) ([]*PersonalAccessToken, *Response, error)
	GetSinglePersonalAccessTokenByID(token int64, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)
	GetSinglePersonalAccessToken(options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)
	RotatePersonalAccessToken(token int64, opt *RotatePersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)
	RotatePersonalAccessTokenByID(token int64, opt *RotatePersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)
	RotatePersonalAccessTokenSelf(opt *RotatePersonalAccessTokenOptions, options ...RequestOptionFunc) (*PersonalAccessToken, *Response, error)
	// Deprecated: to be removed in 2.0; use RevokePersonalAccessTokenByID instead
	RevokePersonalAccessToken(token int64, options ...RequestOptionFunc) (*Response, error)
	RevokePersonalAccessTokenByID(token int64, options ...RequestOptionFunc) (*Response, error)
	RevokePersonalAccessTokenSelf(options ...RequestOptionFunc) (*Response, error)
}

type Pipeline added in v0.4.0 

type Pipeline struct {
	ID             int64           `json:"id"`
	IID            int64           `json:"iid"`
	ProjectID      int64           `json:"project_id"`
	Status         string          `json:"status"`
	Source         PipelineSource  `json:"source"`
	Ref            string          `json:"ref"`
	Name           string          `json:"name"`
	SHA            string          `json:"sha"`
	BeforeSHA      string          `json:"before_sha"`
	Tag            bool            `json:"tag"`
	YamlErrors     string          `json:"yaml_errors"`
	User           *BasicUser      `json:"user"`
	UpdatedAt      *time.Time      `json:"updated_at"`
	CreatedAt      *time.Time      `json:"created_at"`
	StartedAt      *time.Time      `json:"started_at"`
	FinishedAt     *time.Time      `json:"finished_at"`
	CommittedAt    *time.Time      `json:"committed_at"`
	Duration       int64           `json:"duration"`
	QueuedDuration int64           `json:"queued_duration"`
	Coverage       string          `json:"coverage"`
	WebURL         string          `json:"web_url"`
	DetailedStatus *DetailedStatus `json:"detailed_status"`
}

Pipeline represents a GitLab pipeline.

GitLab API docs: https://docs.gitlab.com/api/pipelines/

func (Pipeline) String added in v0.4.0 

func (p Pipeline) String() string

type PipelineEvent added in v0.3.1 

type PipelineEvent struct {
	ObjectKind       string                        `json:"object_kind"`
	ObjectAttributes PipelineEventObjectAttributes `json:"object_attributes"`
	MergeRequest     PipelineEventMergeRequest     `json:"merge_request"`
	User             *EventUser                    `json:"user"`
	Project          PipelineEventProject          `json:"project"`
	Commit           PipelineEventCommit           `json:"commit"`
	SourcePipeline   EventSourcePipeline           `json:"source_pipeline"`
	Builds           []PipelineEventBuild          `json:"builds"`
}

PipelineEvent represents a pipeline event.

GitLab API docs: https://docs.gitlab.com/user/project/integrations/webhook_events/#pipeline-events

type PipelineEventBuild added in v1.0.0 

type PipelineEventBuild struct {
	ID             int64                           `json:"id"`
	Stage          string                          `json:"stage"`
	Name           string                          `json:"name"`
	Status         string                          `json:"status"`
	CreatedAt      string                          `json:"created_at"`
	StartedAt      string                          `json:"started_at"`
	FinishedAt     string                          `json:"finished_at"`
	Duration       float64                         `json:"duration"`
	QueuedDuration float64                         `json:"queued_duration"`
	FailureReason  string                          `json:"failure_reason"`
	When           string                          `json:"when"`
	Manual         bool                            `json:"manual"`
	AllowFailure   bool                            `json:"allow_failure"`
	User           *EventUser                      `json:"user"`
	Runner         PipelineEventBuildRunner        `json:"runner"`
	ArtifactsFile  PipelineEventBuildArtifactsFile `json:"artifacts_file"`
	Environment    EventEnvironment                `json:"environment"`
}

type PipelineEventBuildArtifactsFile added in v1.0.0 

type PipelineEventBuildArtifactsFile struct {
	Filename string `json:"filename"`
	Size     int64  `json:"size"`
}

type PipelineEventBuildRunner added in v1.0.0 

type PipelineEventBuildRunner struct {
	ID          int64    `json:"id"`
	Description string   `json:"description"`
	Active      bool     `json:"active"`
	IsShared    bool     `json:"is_shared"`
	RunnerType  string   `json:"runner_type"`
	Tags        []string `json:"tags"`
}

type PipelineEventCommit added in v1.0.0 

type PipelineEventCommit struct {
	ID        string            `json:"id"`
	Message   string            `json:"message"`
	Title     string            `json:"title"`
	Timestamp *time.Time        `json:"timestamp"`
	URL       string            `json:"url"`
	Author    EventCommitAuthor `json:"author"`
}

type PipelineEventMergeRequest added in v1.0.0 

type PipelineEventMergeRequest struct {
	ID                  int64  `json:"id"`
	IID                 int64  `json:"iid"`
	Title               string `json:"title"`
	SourceBranch        string `json:"source_branch"`
	SourceProjectID     int64  `json:"source_project_id"`
	TargetBranch        string `json:"target_branch"`
	TargetProjectID     int64  `json:"target_project_id"`
	State               string `json:"state"`
	MergeRequestStatus  string `json:"merge_status"`
	DetailedMergeStatus string `json:"detailed_merge_status"`
	URL                 string `json:"url"`
}

type PipelineEventObjectAttributes added in v1.0.0 

type PipelineEventObjectAttributes struct {
	ID             int64                                   `json:"id"`
	IID            int64                                   `json:"iid"`
	Name           string                                  `json:"name"`
	Ref            string                                  `json:"ref"`
	Tag            bool                                    `json:"tag"`
	SHA            string                                  `json:"sha"`
	BeforeSHA      string                                  `json:"before_sha"`
	Source         string                                  `json:"source"`
	Status         string                                  `json:"status"`
	DetailedStatus string                                  `json:"detailed_status"`
	Stages         []string                                `json:"stages"`
	CreatedAt      string                                  `json:"created_at"`
	FinishedAt     string                                  `json:"finished_at"`
	Duration       int64                                   `json:"duration"`
	QueuedDuration int64                                   `json:"queued_duration"`
	URL            string                                  `json:"url"`
	Variables      []PipelineEventObjectAttributesVariable `json:"variables"`
}

type PipelineEventObjectAttributesVariable added in v1.0.0 

type PipelineEventObjectAttributesVariable struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type PipelineEventProject added in v1.0.0 

type PipelineEventProject struct {
	ID                int64           `json:"id"`
	Name              string          `json:"name"`
	Description       string          `json:"description"`
	AvatarURL         string          `json:"avatar_url"`
	GitSSHURL         string          `json:"git_ssh_url"`
	GitHTTPURL        string          `json:"git_http_url"`
	Namespace         string          `json:"namespace"`
	PathWithNamespace string          `json:"path_with_namespace"`
	DefaultBranch     string          `json:"default_branch"`
	Homepage          string          `json:"homepage"`
	URL               string          `json:"url"`
	SSHURL            string          `json:"ssh_url"`
	HTTPURL           string          `json:"http_url"`
	WebURL            string          `json:"web_url"`
	Visibility        VisibilityValue `json:"visibility"`
}

type PipelineInfo added in v0.116.0 

type PipelineInfo struct {
	ID        int64      `json:"id"`
	IID       int64      `json:"iid"`
	ProjectID int64      `json:"project_id"`
	Status    string     `json:"status"`
	Source    string     `json:"source"`
	Ref       string     `json:"ref"`
	SHA       string     `json:"sha"`
	Name      string     `json:"name"`
	WebURL    string     `json:"web_url"`
	UpdatedAt *time.Time `json:"updated_at"`
	CreatedAt *time.Time `json:"created_at"`
}

PipelineInfo shows the basic entities of a pipeline, mostly used as fields on other assets, like Commit.

func (PipelineInfo) String added in v0.116.0 

func (p PipelineInfo) String() string

type PipelineInput added in v0.129.0 

type PipelineInput struct {
	Name    string `json:"name"`
	Value   any    `json:"value"`
	Destroy *bool  `json:"destroy,omitempty"`
}

PipelineInput represents a pipeline input.

GitLab API docs: https://docs.gitlab.com/api/pipelines/

type PipelineInputValue added in v0.146.0 

type PipelineInputValue[T PipelineInputValueType] struct {
	Value T
}

PipelineInputValue wraps a pipeline input value with compile-time type safety. Use NewPipelineInputValue() to create instances of this type.

func NewPipelineInputValue added in v0.146.0 

func NewPipelineInputValue[T PipelineInputValueType](value T) PipelineInputValue[T]

NewPipelineInputValue wraps a value for use in pipeline inputs. Similar to Ptr(), this ensures type safety at compile time. Supported types: string, integers, floats, bool, []string

func (PipelineInputValue[T]) MarshalJSON added in v0.146.0 

func (v PipelineInputValue[T]) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

type PipelineInputValueInterface added in v0.146.0 

type PipelineInputValueInterface interface {
	// contains filtered or unexported methods
}

PipelineInputValueInterface is implemented by PipelineInputValue[T] for supported pipeline input types. Use NewPipelineInputValue() to create instances - do not implement this interface directly.

See PipelineInputsOption for supported types and usage examples.

type PipelineInputValueType added in v0.146.0 

type PipelineInputValueType interface {
	~string | constraintInteger | constraintFloat | ~bool | []string
}

PipelineInputValueType is a type constraint for valid pipeline input value types. This constraint ensures only supported GitLab pipeline input types can be used.

type PipelineInputsOption added in v0.146.0 

type PipelineInputsOption map[string]PipelineInputValueInterface

PipelineInputsOption represents pipeline input parameters with type-safe values. Each value must be wrapped using NewPipelineInputValue() to ensure compile-time type safety.

Supported value types:

  • string
  • integers (int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64)
  • floats (float32, float64)
  • bool
  • []string

Example: 

inputs := PipelineInputsOption{
    "environment": NewPipelineInputValue("production"),
    "replicas":    NewPipelineInputValue(3),
    "debug":       NewPipelineInputValue(false),
    "regions":     NewPipelineInputValue([]string{"us-east", "eu-west"}),
}

GitLab API docs: - https://docs.gitlab.com/api/pipelines/#create-a-new-pipeline - https://docs.gitlab.com/api/pipeline_triggers/#trigger-a-pipeline-with-a-token

type PipelineSchedule added in v0.9.0 

type PipelineSchedule struct {
	ID           int64               `json:"id"`
	Description  string              `json:"description"`
	Ref          string              `json:"ref"`
	Cron         string              `json:"cron"`
	CronTimezone string              `json:"cron_timezone"`
	NextRunAt    *time.Time          `json:"next_run_at"`
	Active       bool                `json:"active"`
	CreatedAt    *time.Time          `json:"created_at"`
	UpdatedAt    *time.Time          `json:"updated_at"`
	Owner        *User               `json:"owner"`
	LastPipeline *LastPipeline       `json:"last_pipeline"`
	Variables    []*PipelineVariable `json:"variables"`
	Inputs       []*PipelineInput    `json:"inputs"`
}

PipelineSchedule represents a pipeline schedule.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/

type PipelineScheduleScopeValue added in v0.129.0 

type PipelineScheduleScopeValue string

PipelineScheduleScopeValue represents a pipeline schedule scope within GitLab.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#get-all-pipeline-schedules 

const (
	PipelineScheduleActive   PipelineScheduleScopeValue = "active"
	PipelineScheduleInactive PipelineScheduleScopeValue = "inactive"
)

List of available pipeline schedule scope values.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#get-all-pipeline-schedules

type PipelineSchedulesService added in v0.9.0 

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

PipelineSchedulesService handles communication with the pipeline schedules related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/

func (*PipelineSchedulesService) CreatePipelineSchedule added in v0.9.0 

func (s *PipelineSchedulesService) CreatePipelineSchedule(pid any, opt *CreatePipelineScheduleOptions, options ...RequestOptionFunc) (*PipelineSchedule, *Response, error)

CreatePipelineSchedule creates a pipeline schedule.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#create-a-new-pipeline-schedule

func (*PipelineSchedulesService) CreatePipelineScheduleVariable added in v0.9.0 

func (s *PipelineSchedulesService) CreatePipelineScheduleVariable(pid any, schedule int64, opt *CreatePipelineScheduleVariableOptions, options ...RequestOptionFunc) (*PipelineVariable, *Response, error)

CreatePipelineScheduleVariable creates a pipeline schedule variable.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#create-a-new-pipeline-schedule

func (*PipelineSchedulesService) DeletePipelineSchedule added in v0.9.0 

func (s *PipelineSchedulesService) DeletePipelineSchedule(pid any, schedule int64, options ...RequestOptionFunc) (*Response, error)

DeletePipelineSchedule deletes a pipeline schedule.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#delete-a-pipeline-schedule

func (*PipelineSchedulesService) DeletePipelineScheduleVariable added in v0.9.0 

func (s *PipelineSchedulesService) DeletePipelineScheduleVariable(pid any, schedule int64, key string, options ...RequestOptionFunc) (*PipelineVariable, *Response, error)

DeletePipelineScheduleVariable creates a pipeline schedule variable.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#delete-a-pipeline-schedule-variable

func (*PipelineSchedulesService) EditPipelineSchedule added in v0.9.0 

func (s *PipelineSchedulesService) EditPipelineSchedule(pid any, schedule int64, opt *EditPipelineScheduleOptions, options ...RequestOptionFunc) (*PipelineSchedule, *Response, error)

EditPipelineSchedule edits a pipeline schedule.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#edit-a-pipeline-schedule

func (*PipelineSchedulesService) EditPipelineScheduleVariable added in v0.9.0 

func (s *PipelineSchedulesService) EditPipelineScheduleVariable(pid any, schedule int64, key string, opt *EditPipelineScheduleVariableOptions, options ...RequestOptionFunc) (*PipelineVariable, *Response, error)

EditPipelineScheduleVariable creates a pipeline schedule variable.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#edit-a-pipeline-schedule-variable

func (*PipelineSchedulesService) GetPipelineSchedule added in v0.9.0 

func (s *PipelineSchedulesService) GetPipelineSchedule(pid any, schedule int64, options ...RequestOptionFunc) (*PipelineSchedule, *Response, error)

GetPipelineSchedule gets a pipeline schedule.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#get-a-single-pipeline-schedule

func (*PipelineSchedulesService) ListPipelineSchedules added in v0.9.0 

func (s *PipelineSchedulesService) ListPipelineSchedules(pid any, opt *ListPipelineSchedulesOptions, options ...RequestOptionFunc) ([]*PipelineSchedule, *Response, error)

ListPipelineSchedules gets a list of project triggers.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#get-all-pipeline-schedules

func (*PipelineSchedulesService) ListPipelinesTriggeredBySchedule added in v0.116.0 

func (s *PipelineSchedulesService) ListPipelinesTriggeredBySchedule(pid any, schedule int64, opt *ListPipelinesTriggeredByScheduleOptions, options ...RequestOptionFunc) ([]*Pipeline, *Response, error)

ListPipelinesTriggeredBySchedule gets all pipelines triggered by a pipeline schedule.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#get-all-pipelines-triggered-by-a-pipeline-schedule

func (*PipelineSchedulesService) RunPipelineSchedule added in v0.116.0 

func (s *PipelineSchedulesService) RunPipelineSchedule(pid any, schedule int64, options ...RequestOptionFunc) (*Response, error)

RunPipelineSchedule triggers a new scheduled pipeline to run immediately.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#run-a-scheduled-pipeline-immediately

func (*PipelineSchedulesService) TakeOwnershipOfPipelineSchedule added in v0.9.0 

func (s *PipelineSchedulesService) TakeOwnershipOfPipelineSchedule(pid any, schedule int64, options ...RequestOptionFunc) (*PipelineSchedule, *Response, error)

TakeOwnershipOfPipelineSchedule sets the owner of the specified pipeline schedule to the user issuing the request.

GitLab API docs: https://docs.gitlab.com/api/pipeline_schedules/#take-ownership-of-a-pipeline-schedule

type PipelineSchedulesServiceInterface added in v0.126.0 

type PipelineSchedulesServiceInterface interface {
	ListPipelineSchedules(pid any, opt *ListPipelineSchedulesOptions, options ...RequestOptionFunc) ([]*PipelineSchedule, *Response, error)
	GetPipelineSchedule(pid any, schedule int64, options ...RequestOptionFunc) (*PipelineSchedule, *Response, error)
	ListPipelinesTriggeredBySchedule(pid any, schedule int64, opt *ListPipelinesTriggeredByScheduleOptions, options ...RequestOptionFunc) ([]*Pipeline, *Response, error)
	CreatePipelineSchedule(pid any, opt *CreatePipelineScheduleOptions, options ...RequestOptionFunc) (*PipelineSchedule, *Response, error)
	EditPipelineSchedule(pid any, schedule int64, opt *EditPipelineScheduleOptions, options ...RequestOptionFunc) (*PipelineSchedule, *Response, error)
	TakeOwnershipOfPipelineSchedule(pid any, schedule int64, options ...RequestOptionFunc) (*PipelineSchedule, *Response, error)
	DeletePipelineSchedule(pid any, schedule int64, options ...RequestOptionFunc) (*Response, error)
	RunPipelineSchedule(pid any, schedule int64, options ...RequestOptionFunc) (*Response, error)
	CreatePipelineScheduleVariable(pid any, schedule int64, opt *CreatePipelineScheduleVariableOptions, options ...RequestOptionFunc) (*PipelineVariable, *Response, error)
	EditPipelineScheduleVariable(pid any, schedule int64, key string, opt *EditPipelineScheduleVariableOptions, options ...RequestOptionFunc) (*PipelineVariable, *Response, error)
	DeletePipelineScheduleVariable(pid any, schedule int64, key string, options ...RequestOptionFunc) (*PipelineVariable, *Response, error)
}

type PipelineSource added in v0.128.0 

type PipelineSource string
const (
	PipelineSourceAPI                         PipelineSource = "api"
	PipelineSourceChat                        PipelineSource = "chat"
	PipelineSourceExternal                    PipelineSource = "external"
	PipelineSourceExternalPullRequestEvent    PipelineSource = "external_pull_request_event"
	PipelineSourceMergeRequestEvent           PipelineSource = "merge_request_event"
	PipelineSourceOndemandDastScan            PipelineSource = "ondemand_dast_scan"
	PipelineSourceOndemandDastValidation      PipelineSource = "ondemand_dast_validation"
	PipelineSourceParentPipeline              PipelineSource = "parent_pipeline"
	PipelineSourcePipeline                    PipelineSource = "pipeline"
	PipelineSourcePush                        PipelineSource = "push"
	PipelineSourceSchedule                    PipelineSource = "schedule"
	PipelineSourceSecurityOrchestrationPolicy PipelineSource = "security_orchestration_policy"
	PipelineSourceTrigger                     PipelineSource = "trigger"
	PipelineSourceWeb                         PipelineSource = "web"
	PipelineSourceWebIDE                      PipelineSource = "webide"
)

PipelineSource is the source of a pipeline. GitLab API docs: https://docs.gitlab.com/ci/jobs/job_rules/#ci_pipeline_source-predefined-variable

type PipelineTestCases added in v0.116.0 

type PipelineTestCases struct {
	Status         string          `json:"status"`
	Name           string          `json:"name"`
	Classname      string          `json:"classname"`
	File           string          `json:"file"`
	ExecutionTime  float64         `json:"execution_time"`
	SystemOutput   any             `json:"system_output"`
	StackTrace     string          `json:"stack_trace"`
	AttachmentURL  string          `json:"attachment_url"`
	RecentFailures *RecentFailures `json:"recent_failures"`
}

PipelineTestCases contains test cases details.

type PipelineTestReport added in v0.116.0 

type PipelineTestReport struct {
	TotalTime    float64               `json:"total_time"`
	TotalCount   int64                 `json:"total_count"`
	SuccessCount int64                 `json:"success_count"`
	FailedCount  int64                 `json:"failed_count"`
	SkippedCount int64                 `json:"skipped_count"`
	ErrorCount   int64                 `json:"error_count"`
	TestSuites   []*PipelineTestSuites `json:"test_suites"`
}

PipelineTestReport contains a detailed report of a test run.

func (PipelineTestReport) String added in v0.116.0 

func (p PipelineTestReport) String() string

type PipelineTestReportSummary added in v0.156.0 

type PipelineTestReportSummary struct {
	Total      PipelineTotalSummary       `json:"total"`
	TestSuites []PipelineTestSuiteSummary `json:"test_suites"`
}

PipelineTestReportSummary contains a summary report of a test run

type PipelineTestSuiteSummary added in v0.156.0 

type PipelineTestSuiteSummary struct {
	Name         string  `json:"name"`
	TotalTime    float64 `json:"total_time"`
	TotalCount   int64   `json:"total_count"`
	SuccessCount int64   `json:"success_count"`
	FailedCount  int64   `json:"failed_count"`
	SkippedCount int64   `json:"skipped_count"`
	ErrorCount   int64   `json:"error_count"`
	BuildIDs     []int64 `json:"build_ids"`
	SuiteError   *string `json:"suite_error"`
}

PipelineTestSuiteSummary contains a test suite summary of a test run

type PipelineTestSuites added in v0.116.0 

type PipelineTestSuites struct {
	Name         string               `json:"name"`
	TotalTime    float64              `json:"total_time"`
	TotalCount   int64                `json:"total_count"`
	SuccessCount int64                `json:"success_count"`
	FailedCount  int64                `json:"failed_count"`
	SkippedCount int64                `json:"skipped_count"`
	ErrorCount   int64                `json:"error_count"`
	TestCases    []*PipelineTestCases `json:"test_cases"`
}

PipelineTestSuites contains test suites results.

type PipelineTotalSummary added in v0.156.0 

type PipelineTotalSummary struct {
	// Documentation examples only show whole numbers, but the test specs for GitLab show decimals, so `float64` is the better attribute here.
	Time       float64 `json:"time"`
	Count      int64   `json:"count"`
	Success    int64   `json:"success"`
	Failed     int64   `json:"failed"`
	Skipped    int64   `json:"skipped"`
	Error      int64   `json:"error"`
	SuiteError *string `json:"suite_error"`
}

PipelineTotalSummary contains a total summary of a test run

type PipelineTrigger added in v0.6.0 

type PipelineTrigger struct {
	ID          int64      `json:"id"`
	Description string     `json:"description"`
	CreatedAt   *time.Time `json:"created_at"`
	DeletedAt   *time.Time `json:"deleted_at"`
	LastUsed    *time.Time `json:"last_used"`
	Token       string     `json:"token"`
	UpdatedAt   *time.Time `json:"updated_at"`
	Owner       *User      `json:"owner"`
}

PipelineTrigger represents a project pipeline trigger.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/

type PipelineTriggersService added in v0.6.0 

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

PipelineTriggersService handles Project pipeline triggers.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/

func (*PipelineTriggersService) AddPipelineTrigger added in v0.6.0 

func (s *PipelineTriggersService) AddPipelineTrigger(pid any, opt *AddPipelineTriggerOptions, options ...RequestOptionFunc) (*PipelineTrigger, *Response, error)

AddPipelineTrigger adds a pipeline trigger to a specified project.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/#create-a-trigger-token

func (*PipelineTriggersService) DeletePipelineTrigger added in v0.6.0 

func (s *PipelineTriggersService) DeletePipelineTrigger(pid any, trigger int64, options ...RequestOptionFunc) (*Response, error)

DeletePipelineTrigger removes a trigger from a project.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/#remove-a-pipeline-trigger-token

func (*PipelineTriggersService) EditPipelineTrigger added in v0.6.0 

func (s *PipelineTriggersService) EditPipelineTrigger(pid any, trigger int64, opt *EditPipelineTriggerOptions, options ...RequestOptionFunc) (*PipelineTrigger, *Response, error)

EditPipelineTrigger edits a trigger for a specified project.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/#update-a-pipeline-trigger-token

func (*PipelineTriggersService) GetPipelineTrigger added in v0.6.0 

func (s *PipelineTriggersService) GetPipelineTrigger(pid any, trigger int64, options ...RequestOptionFunc) (*PipelineTrigger, *Response, error)

GetPipelineTrigger gets a specific pipeline trigger for a project.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/#get-trigger-token-details

func (*PipelineTriggersService) ListPipelineTriggers added in v0.6.0 

func (s *PipelineTriggersService) ListPipelineTriggers(pid any, opt *ListPipelineTriggersOptions, options ...RequestOptionFunc) ([]*PipelineTrigger, *Response, error)

ListPipelineTriggers gets a list of project triggers.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/#list-project-trigger-tokens

func (*PipelineTriggersService) RunPipelineTrigger added in v0.7.0 

func (s *PipelineTriggersService) RunPipelineTrigger(pid any, opt *RunPipelineTriggerOptions, options ...RequestOptionFunc) (*Pipeline, *Response, error)

RunPipelineTrigger starts a trigger from a project.

GitLab API docs: https://docs.gitlab.com/api/pipeline_triggers/#trigger-a-pipeline-with-a-token

type PipelineTriggersServiceInterface added in v0.126.0 

type PipelineTriggersServiceInterface interface {
	ListPipelineTriggers(pid any, opt *ListPipelineTriggersOptions, options ...RequestOptionFunc) ([]*PipelineTrigger, *Response, error)
	GetPipelineTrigger(pid any, trigger int64, options ...RequestOptionFunc) (*PipelineTrigger, *Response, error)
	AddPipelineTrigger(pid any, opt *AddPipelineTriggerOptions, options ...RequestOptionFunc) (*PipelineTrigger, *Response, error)
	EditPipelineTrigger(pid any, trigger int64, opt *EditPipelineTriggerOptions, options ...RequestOptionFunc) (*PipelineTrigger, *Response, error)
	DeletePipelineTrigger(pid any, trigger int64, options ...RequestOptionFunc) (*Response, error)
	RunPipelineTrigger(pid any, opt *RunPipelineTriggerOptions, options ...RequestOptionFunc) (*Pipeline, *Response, error)
}

type PipelineVariable added in v0.9.0 

type PipelineVariable struct {
	Key          string            `json:"key"`
	Value        string            `json:"value"`
	VariableType VariableTypeValue `json:"variable_type"`
}

PipelineVariable represents a pipeline variable.

GitLab API docs: https://docs.gitlab.com/api/pipelines/

type PipelineVariableOptions added in v0.116.0 

type PipelineVariableOptions struct {
	Key          *string            `url:"key,omitempty" json:"key,omitempty"`
	Value        *string            `url:"value,omitempty" json:"value,omitempty"`
	VariableType *VariableTypeValue `url:"variable_type,omitempty" json:"variable_type,omitempty"`
}

PipelineVariableOptions represents a pipeline variable option.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#create-a-new-pipeline

type PipelinesEmailProperties added in v0.116.0 

type PipelinesEmailProperties struct {
	Recipients                string    `json:"recipients"`
	NotifyOnlyBrokenPipelines BoolValue `json:"notify_only_broken_pipelines"`
	NotifyOnlyDefaultBranch   BoolValue `json:"notify_only_default_branch"`
	BranchesToBeNotified      string    `json:"branches_to_be_notified"`
}

PipelinesEmailProperties represents PipelinesEmail specific properties.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#pipeline-status-emails

type PipelinesEmailService added in v0.116.0 

type PipelinesEmailService struct {
	Service
	Properties *PipelinesEmailProperties `json:"properties"`
}

PipelinesEmailService represents Pipelines Email service settings.

GitLab API docs: https://docs.gitlab.com/api/project_integrations/#pipeline-status-emails

type PipelinesService added in v0.4.0 

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

PipelinesService handles communication with the repositories related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/pipelines/

func (*PipelinesService) CancelPipelineBuild added in v0.4.0 

func (s *PipelinesService) CancelPipelineBuild(pid any, pipeline int64, options ...RequestOptionFunc) (*Pipeline, *Response, error)

CancelPipelineBuild cancels a pipeline builds.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#cancel-a-pipelines-jobs

func (*PipelinesService) CreatePipeline added in v0.4.0 

func (s *PipelinesService) CreatePipeline(pid any, opt *CreatePipelineOptions, options ...RequestOptionFunc) (*Pipeline, *Response, error)

CreatePipeline creates a new project pipeline.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#create-a-new-pipeline

func (*PipelinesService) DeletePipeline added in v0.116.0 

func (s *PipelinesService) DeletePipeline(pid any, pipeline int64, options ...RequestOptionFunc) (*Response, error)

DeletePipeline deletes an existing pipeline.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#delete-a-pipeline

func (*PipelinesService) GetLatestPipeline added in v0.116.0 

func (s *PipelinesService) GetLatestPipeline(pid any, opt *GetLatestPipelineOptions, options ...RequestOptionFunc) (*Pipeline, *Response, error)

GetLatestPipeline gets the latest pipeline for a specific ref in a project.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#get-the-latest-pipeline

func (*PipelinesService) GetPipeline added in v0.4.0 

func (s *PipelinesService) GetPipeline(pid any, pipeline int64, options ...RequestOptionFunc) (*Pipeline, *Response, error)

GetPipeline gets a single project pipeline.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#get-a-single-pipeline

func (*PipelinesService) GetPipelineTestReport added in v0.116.0 

func (s *PipelinesService) GetPipelineTestReport(pid any, pipeline int64, options ...RequestOptionFunc) (*PipelineTestReport, *Response, error)

GetPipelineTestReport gets the test report of a single project pipeline.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#get-a-pipelines-test-report

func (*PipelinesService) GetPipelineTestReportSummary added in v0.156.0 

func (s *PipelinesService) GetPipelineTestReportSummary(pid any, pipeline int64, options ...RequestOptionFunc) (*PipelineTestReportSummary, *Response, error)

GetPipelineTestReportSummary gets the test report summary of a single project pipeline.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#get-a-test-report-summary-for-a-pipeline

func (*PipelinesService) GetPipelineVariables added in v0.116.0 

func (s *PipelinesService) GetPipelineVariables(pid any, pipeline int64, options ...RequestOptionFunc) ([]*PipelineVariable, *Response, error)

GetPipelineVariables gets the variables of a single project pipeline.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#get-variables-of-a-pipeline

func (*PipelinesService) ListProjectPipelines added in v0.4.0 

func (s *PipelinesService) ListProjectPipelines(pid any, opt *ListProjectPipelinesOptions, options ...RequestOptionFunc) ([]*PipelineInfo, *Response, error)

ListProjectPipelines gets a list of project pipelines.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#list-project-pipelines

func (*PipelinesService) RetryPipelineBuild added in v0.4.0 

func (s *PipelinesService) RetryPipelineBuild(pid any, pipeline int64, options ...RequestOptionFunc) (*Pipeline, *Response, error)

RetryPipelineBuild retries failed builds in a pipeline.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#retry-jobs-in-a-pipeline

func (*PipelinesService) UpdatePipelineMetadata added in v0.116.0 

func (s *PipelinesService) UpdatePipelineMetadata(pid any, pipeline int64, opt *UpdatePipelineMetadataOptions, options ...RequestOptionFunc) (*Pipeline, *Response, error)

UpdatePipelineMetadata You can update the metadata of a pipeline. The metadata contains the name of the pipeline.

GitLab API docs: https://docs.gitlab.com/api/pipelines/#update-pipeline-metadata

type PipelinesServiceInterface added in v0.126.0 

type PipelinesServiceInterface interface {
	ListProjectPipelines(pid any, opt *ListProjectPipelinesOptions, options ...RequestOptionFunc) ([]*PipelineInfo, *Response, error)
	GetPipeline(pid any, pipeline int64, options ...RequestOptionFunc) (*Pipeline, *Response, error)
	GetPipelineVariables(pid any, pipeline int64, options ...RequestOptionFunc) ([]*PipelineVariable, *Response, error)
	GetPipelineTestReport(pid any, pipeline int64, options ...RequestOptionFunc) (*PipelineTestReport, *Response, error)
	GetPipelineTestReportSummary(pid any, pipeline int64, options ...RequestOptionFunc) (*PipelineTestReportSummary, *Response, error)
	GetLatestPipeline(pid any, opt *GetLatestPipelineOptions, options ...RequestOptionFunc) (*Pipeline, *Response, error)
	CreatePipeline(pid any, opt *CreatePipelineOptions, options ...RequestOptionFunc) (*Pipeline, *Response, error)
	RetryPipelineBuild(pid any, pipeline int64, options ...RequestOptionFunc) (*Pipeline, *Response, error)
	CancelPipelineBuild(pid any, pipeline int64, options ...RequestOptionFunc) (*Pipeline, *Response, error)
	DeletePipeline(pid any, pipeline int64, options ...RequestOptionFunc) (*Response, error)
	UpdatePipelineMetadata(pid any, pipeline int64, opt *UpdatePipelineMetadataOptions, options ...RequestOptionFunc) (*Pipeline, *Response, error)
}

type PlanLimit added in v0.116.0 

type PlanLimit struct {
	ConanMaxFileSize           int64 `json:"conan_max_file_size,omitempty"`
	GenericPackagesMaxFileSize int64 `json:"generic_packages_max_file_size,omitempty"`
	HelmMaxFileSize            int64 `json:"helm_max_file_size,omitempty"`
	MavenMaxFileSize           int64 `json:"maven_max_file_size,omitempty"`
	NPMMaxFileSize             int64 `json:"npm_max_file_size,omitempty"`
	NugetMaxFileSize           int64 `json:"nuget_max_file_size,omitempty"`
	PyPiMaxFileSize            int64 `json:"pypi_max_file_size,omitempty"`
	TerraformModuleMaxFileSize int64 `json:"terraform_module_max_file_size,omitempty"`
}

PlanLimit represents a GitLab pipeline.

GitLab API docs: https://docs.gitlab.com/api/plan_limits/

type PlanLimitsService added in v0.116.0 

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

PlanLimitsService handles communication with the repositories related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/plan_limits/

func (*PlanLimitsService) ChangePlanLimits added in v0.116.0 

func (s *PlanLimitsService) ChangePlanLimits(opt *ChangePlanLimitOptions, options ...RequestOptionFunc) (*PlanLimit, *Response, error)

ChangePlanLimits modifies the limits of a plan on the GitLab instance.

GitLab API docs: https://docs.gitlab.com/api/plan_limits/#change-plan-limits

func (*PlanLimitsService) GetCurrentPlanLimits added in v0.116.0 

func (s *PlanLimitsService) GetCurrentPlanLimits(opt *GetCurrentPlanLimitsOptions, options ...RequestOptionFunc) (*PlanLimit, *Response, error)

GetCurrentPlanLimits lists the current limits of a plan on the GitLab instance.

GitLab API docs: https://docs.gitlab.com/api/plan_limits/#get-current-plan-limits

type PlanLimitsServiceInterface added in v0.126.0 

type PlanLimitsServiceInterface interface {
	GetCurrentPlanLimits(opt *GetCurrentPlanLimitsOptions, options ...RequestOptionFunc) (*PlanLimit, *Response, error)
	ChangePlanLimits(opt *ChangePlanLimitOptions, options ...RequestOptionFunc) (*PlanLimit, *Response, error)
}

type PlatformKubernetes added in v0.116.0 

type PlatformKubernetes struct {
	APIURL            string `json:"api_url"`
	Token             string `json:"token"`
	CaCert            string `json:"ca_cert"`
	Namespace         string `json:"namespace"`
	AuthorizationType string `json:"authorization_type"`
}

PlatformKubernetes represents a GitLab Project Cluster PlatformKubernetes. Deprecated: in GitLab 14.5, to be removed in 19.0

type PlayJobOptions added in v0.116.0 

type PlayJobOptions struct {
	JobVariablesAttributes *[]*JobVariableOptions `url:"job_variables_attributes,omitempty" json:"job_variables_attributes,omitempty"`
}

PlayJobOptions represents the available PlayJob() options.

GitLab API docs: https://docs.gitlab.com/api/jobs/#run-a-job

type PositionOptions added in v0.116.0 

type PositionOptions struct {
	BaseSHA      *string           `url:"base_sha,omitempty" json:"base_sha,omitempty"`
	HeadSHA      *string           `url:"head_sha,omitempty" json:"head_sha,omitempty"`
	StartSHA     *string           `url:"start_sha,omitempty" json:"start_sha,omitempty"`
	NewPath      *string           `url:"new_path,omitempty" json:"new_path,omitempty"`
	OldPath      *string           `url:"old_path,omitempty" json:"old_path,omitempty"`
	PositionType *string           `url:"position_type,omitempty" json:"position_type"`
	NewLine      *int64            `url:"new_line,omitempty" json:"new_line,omitempty"`
	OldLine      *int64            `url:"old_line,omitempty" json:"old_line,omitempty"`
	LineRange    *LineRangeOptions `url:"line_range,omitempty" json:"line_range,omitempty"`
	Width        *int64            `url:"width,omitempty" json:"width,omitempty"`
	Height       *int64            `url:"height,omitempty" json:"height,omitempty"`
	X            *float64          `url:"x,omitempty" json:"x,omitempty"`
	Y            *float64          `url:"y,omitempty" json:"y,omitempty"`
}

PositionOptions represents the position option of a discussion.

type PostCommitCommentOptions 

type PostCommitCommentOptions struct {
	Note     *string `url:"note,omitempty" json:"note,omitempty"`
	Path     *string `url:"path" json:"path"`
	Line     *int64  `url:"line" json:"line"`
	LineType *string `url:"line_type" json:"line_type"`
}

PostCommitCommentOptions represents the available PostCommitComment() options.

GitLab API docs: https://docs.gitlab.com/api/commits/#post-comment-to-commit

type ProcessMetrics added in v0.8.1 

type ProcessMetrics struct {
	Processes []ProcessMetricsProcess `json:"processes"`
}

ProcessMetrics represents the GitLab sidekiq process metrics.

GitLab API docs: https://docs.gitlab.com/api/sidekiq_metrics/#get-the-current-process-metrics

type ProcessMetricsProcess added in v1.0.0 

type ProcessMetricsProcess struct {
	Hostname    string     `json:"hostname"`
	Pid         int64      `json:"pid"`
	Tag         string     `json:"tag"`
	StartedAt   *time.Time `json:"started_at"`
	Queues      []string   `json:"queues"`
	Labels      []string   `json:"labels"`
	Concurrency int64      `json:"concurrency"`
	Busy        int64      `json:"busy"`
}

ProcessMetricsProcess represents the GitLab sidekiq process metrics process.

GitLab API docs: https://docs.gitlab.com/api/sidekiq_metrics/#get-the-current-process-metrics

type Project 

type Project struct {
	ID                                        int64                                       `json:"id"`
	Description                               string                                      `json:"description"`
	DefaultBranch                             string                                      `json:"default_branch"`
	Visibility                                VisibilityValue                             `json:"visibility"`
	SSHURLToRepo                              string                                      `json:"ssh_url_to_repo"`
	HTTPURLToRepo                             string                                      `json:"http_url_to_repo"`
	WebURL                                    string                                      `json:"web_url"`
	ReadmeURL                                 string                                      `json:"readme_url"`
	Topics                                    []string                                    `json:"topics"`
	Owner                                     *User                                       `json:"owner"`
	Name                                      string                                      `json:"name"`
	NameWithNamespace                         string                                      `json:"name_with_namespace"`
	Path                                      string                                      `json:"path"`
	PathWithNamespace                         string                                      `json:"path_with_namespace"`
	OpenIssuesCount                           int64                                       `json:"open_issues_count"`
	ResolveOutdatedDiffDiscussions            bool                                        `json:"resolve_outdated_diff_discussions"`
	ContainerExpirationPolicy                 *ContainerExpirationPolicy                  `json:"container_expiration_policy,omitempty"`
	ContainerRegistryAccessLevel              AccessControlValue                          `json:"container_registry_access_level"`
	ContainerRegistryImagePrefix              string                                      `json:"container_registry_image_prefix,omitempty"`
	CreatedAt                                 *time.Time                                  `json:"created_at,omitempty"`
	UpdatedAt                                 *time.Time                                  `json:"updated_at,omitempty"`
	LastActivityAt                            *time.Time                                  `json:"last_activity_at,omitempty"`
	CreatorID                                 int64                                       `json:"creator_id"`
	Namespace                                 *ProjectNamespace                           `json:"namespace"`
	Permissions                               *Permissions                                `json:"permissions"`
	MarkedForDeletionOn                       *ISOTime                                    `json:"marked_for_deletion_on"`
	EmptyRepo                                 bool                                        `json:"empty_repo"`
	Archived                                  bool                                        `json:"archived"`
	AvatarURL                                 string                                      `json:"avatar_url"`
	LicenseURL                                string                                      `json:"license_url"`
	License                                   *ProjectLicense                             `json:"license"`
	SharedRunnersEnabled                      bool                                        `json:"shared_runners_enabled"`
	GroupRunnersEnabled                       bool                                        `json:"group_runners_enabled"`
	ResourceGroupDefaultProcessMode           ResourceGroupProcessMode                    `json:"resource_group_default_process_mode"`
	RunnerTokenExpirationInterval             int64                                       `json:"runner_token_expiration_interval"`
	ForksCount                                int64                                       `json:"forks_count"`
	StarCount                                 int64                                       `json:"star_count"`
	RunnersToken                              string                                      `json:"runners_token"`
	AllowMergeOnSkippedPipeline               bool                                        `json:"allow_merge_on_skipped_pipeline"`
	AllowPipelineTriggerApproveDeployment     bool                                        `json:"allow_pipeline_trigger_approve_deployment"`
	OnlyAllowMergeIfPipelineSucceeds          bool                                        `json:"only_allow_merge_if_pipeline_succeeds"`
	OnlyAllowMergeIfAllDiscussionsAreResolved bool                                        `json:"only_allow_merge_if_all_discussions_are_resolved"`
	RemoveSourceBranchAfterMerge              bool                                        `json:"remove_source_branch_after_merge"`
	PreventMergeWithoutJiraIssue              bool                                        `json:"prevent_merge_without_jira_issue"`
	PrintingMergeRequestLinkEnabled           bool                                        `json:"printing_merge_request_link_enabled"`
	LFSEnabled                                bool                                        `json:"lfs_enabled"`
	MaxArtifactsSize                          int64                                       `json:"max_artifacts_size"`
	RepositoryStorage                         string                                      `json:"repository_storage"`
	RequestAccessEnabled                      bool                                        `json:"request_access_enabled"`
	MergeMethod                               MergeMethodValue                            `json:"merge_method"`
	CanCreateMergeRequestIn                   bool                                        `json:"can_create_merge_request_in"`
	ForkedFromProject                         *ForkParent                                 `json:"forked_from_project"`
	Mirror                                    bool                                        `json:"mirror"`
	MirrorUserID                              int64                                       `json:"mirror_user_id"`
	MirrorTriggerBuilds                       bool                                        `json:"mirror_trigger_builds"`
	OnlyMirrorProtectedBranches               bool                                        `json:"only_mirror_protected_branches"`
	MirrorOverwritesDivergedBranches          bool                                        `json:"mirror_overwrites_diverged_branches"`
	PackagesEnabled                           bool                                        `json:"packages_enabled"`
	ServiceDeskEnabled                        bool                                        `json:"service_desk_enabled"`
	ServiceDeskAddress                        string                                      `json:"service_desk_address"`
	IssuesAccessLevel                         AccessControlValue                          `json:"issues_access_level"`
	ReleasesAccessLevel                       AccessControlValue                          `json:"releases_access_level,omitempty"`
	RepositoryAccessLevel                     AccessControlValue                          `json:"repository_access_level"`
	MergeRequestsAccessLevel                  AccessControlValue                          `json:"merge_requests_access_level"`
	ForkingAccessLevel                        AccessControlValue                          `json:"forking_access_level"`
	WikiAccessLevel                           AccessControlValue                          `json:"wiki_access_level"`
	BuildsAccessLevel                         AccessControlValue                          `json:"builds_access_level"`
	SnippetsAccessLevel                       AccessControlValue                          `json:"snippets_access_level"`
	PagesAccessLevel                          AccessControlValue                          `json:"pages_access_level"`
	OperationsAccessLevel                     AccessControlValue                          `json:"operations_access_level"`
	AnalyticsAccessLevel                      AccessControlValue                          `json:"analytics_access_level"`
	EnvironmentsAccessLevel                   AccessControlValue                          `json:"environments_access_level"`
	FeatureFlagsAccessLevel                   AccessControlValue                          `json:"feature_flags_access_level"`
	InfrastructureAccessLevel                 AccessControlValue                          `json:"infrastructure_access_level"`
	MonitorAccessLevel                        AccessControlValue                          `json:"monitor_access_level"`
	AutocloseReferencedIssues                 bool                                        `json:"autoclose_referenced_issues"`
	SuggestionCommitMessage                   string                                      `json:"suggestion_commit_message"`
	SquashOption                              SquashOptionValue                           `json:"squash_option"`
	EnforceAuthChecksOnUploads                bool                                        `json:"enforce_auth_checks_on_uploads,omitempty"`
	SharedWithGroups                          []ProjectSharedWithGroup                    `json:"shared_with_groups"`
	Statistics                                *Statistics                                 `json:"statistics"`
	Links                                     *Links                                      `json:"_links,omitempty"`
	ImportURL                                 string                                      `json:"import_url"`
	ImportType                                string                                      `json:"import_type"`
	ImportStatus                              string                                      `json:"import_status"`
	ImportError                               string                                      `json:"import_error"`
	CIDefaultGitDepth                         int64                                       `json:"ci_default_git_depth"`
	CIDeletePipelinesInSeconds                int64                                       `json:"ci_delete_pipelines_in_seconds,omitempty"`
	CIForwardDeploymentEnabled                bool                                        `json:"ci_forward_deployment_enabled"`
	CIForwardDeploymentRollbackAllowed        bool                                        `json:"ci_forward_deployment_rollback_allowed"`
	CIPushRepositoryForJobTokenAllowed        bool                                        `json:"ci_push_repository_for_job_token_allowed"`
	CIIdTokenSubClaimComponents               []string                                    `json:"ci_id_token_sub_claim_components"`
	CISeparatedCaches                         bool                                        `json:"ci_separated_caches"`
	CIJobTokenScopeEnabled                    bool                                        `json:"ci_job_token_scope_enabled"`
	CIOptInJWT                                bool                                        `json:"ci_opt_in_jwt"`
	CIAllowForkPipelinesToRunInParentProject  bool                                        `json:"ci_allow_fork_pipelines_to_run_in_parent_project"`
	CIRestrictPipelineCancellationRole        AccessControlValue                          `json:"ci_restrict_pipeline_cancellation_role"`
	PublicJobs                                bool                                        `json:"public_jobs"`
	BuildTimeout                              int64                                       `json:"build_timeout"`
	AutoCancelPendingPipelines                string                                      `json:"auto_cancel_pending_pipelines"`
	CIConfigPath                              string                                      `json:"ci_config_path"`
	CustomAttributes                          []*CustomAttribute                          `json:"custom_attributes"`
	ComplianceFrameworks                      []string                                    `json:"compliance_frameworks"`
	BuildCoverageRegex                        string                                      `json:"build_coverage_regex"`
	IssuesTemplate                            string                                      `json:"issues_template"`
	MergeRequestsTemplate                     string                                      `json:"merge_requests_template"`
	IssueBranchTemplate                       string                                      `json:"issue_branch_template"`
	KeepLatestArtifact                        bool                                        `json:"keep_latest_artifact"`
	MergePipelinesEnabled                     bool                                        `json:"merge_pipelines_enabled"`
	MergeTrainsEnabled                        bool                                        `json:"merge_trains_enabled"`
	MergeTrainsSkipTrainAllowed               bool                                        `json:"merge_trains_skip_train_allowed"`
	CIPipelineVariablesMinimumOverrideRole    CIPipelineVariablesMinimumOverrideRoleValue `json:"ci_pipeline_variables_minimum_override_role"`
	MergeCommitTemplate                       string                                      `json:"merge_commit_template"`
	SquashCommitTemplate                      string                                      `json:"squash_commit_template"`
	AutoDevopsDeployStrategy                  string                                      `json:"auto_devops_deploy_strategy"`
	AutoDevopsEnabled                         bool                                        `json:"auto_devops_enabled"`
	BuildGitStrategy                          string                                      `json:"build_git_strategy"`
	EmailsEnabled                             bool                                        `json:"emails_enabled"`
	ExternalAuthorizationClassificationLabel  string                                      `json:"external_authorization_classification_label"`
	RequirementsEnabled                       bool                                        `json:"requirements_enabled"`
	RequirementsAccessLevel                   AccessControlValue                          `json:"requirements_access_level"`
	SecurityAndComplianceEnabled              bool                                        `json:"security_and_compliance_enabled"`
	SecurityAndComplianceAccessLevel          AccessControlValue                          `json:"security_and_compliance_access_level"`
	MergeRequestDefaultTargetSelf             bool                                        `json:"mr_default_target_self"`
	ModelExperimentsAccessLevel               AccessControlValue                          `json:"model_experiments_access_level"`
	ModelRegistryAccessLevel                  AccessControlValue                          `json:"model_registry_access_level"`
	PreReceiveSecretDetectionEnabled          bool                                        `json:"pre_receive_secret_detection_enabled"`
	AutoDuoCodeReviewEnabled                  bool                                        `json:"auto_duo_code_review_enabled"`

	// Deprecated: use Topics instead
	TagList []string `json:"tag_list"`
	// Deprecated: use IssuesAccessLevel instead
	IssuesEnabled bool `json:"issues_enabled"`
	// Deprecated: use MergeRequestsAccessLevel instead
	MergeRequestsEnabled bool `json:"merge_requests_enabled"`
	// Deprecated: use Merge Request Approvals API instead
	ApprovalsBeforeMerge int64 `json:"approvals_before_merge"`
	// Deprecated: use BuildsAccessLevel instead
	JobsEnabled bool `json:"jobs_enabled"`
	// Deprecated: use WikiAccessLevel instead
	WikiEnabled bool `json:"wiki_enabled"`
	// Deprecated: use SnippetsAccessLevel instead
	SnippetsEnabled bool `json:"snippets_enabled"`
	// Deprecated: use ContainerRegistryAccessLevel instead
	ContainerRegistryEnabled bool `json:"container_registry_enabled"`
	// Deprecated: use MarkedForDeletionOn instead
	MarkedForDeletionAt *ISOTime `json:"marked_for_deletion_at"`
	// Deprecated: use CIPipelineVariablesMinimumOverrideRole instead
	RestrictUserDefinedVariables bool `json:"restrict_user_defined_variables"`
	// Deprecated: Use EmailsEnabled instead
	EmailsDisabled bool `json:"emails_disabled"`
	// Deprecated: This parameter has been renamed to PublicJobs in GitLab 9.0.
	PublicBuilds bool `json:"public_builds"`
}

Project represents a GitLab project.

GitLab API docs: https://docs.gitlab.com/api/projects/

func (Project) String 

func (s Project) String() string

type ProjectAccess 

type ProjectAccess struct {
	AccessLevel       AccessLevelValue       `json:"access_level"`
	NotificationLevel NotificationLevelValue `json:"notification_level"`
}

ProjectAccess represents project access.

type ProjectAccessToken added in v0.116.0 

type ProjectAccessToken resourceAccessToken

ProjectAccessToken represents a GitLab project access token.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/

func (ProjectAccessToken) String added in v0.116.0 

func (v ProjectAccessToken) String() string

type ProjectAccessTokensService added in v0.116.0 

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

ProjectAccessTokensService handles communication with the project access tokens related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/

func (*ProjectAccessTokensService) CreateProjectAccessToken added in v0.116.0 

func (s *ProjectAccessTokensService) CreateProjectAccessToken(pid any, opt *CreateProjectAccessTokenOptions, options ...RequestOptionFunc) (*ProjectAccessToken, *Response, error)

CreateProjectAccessToken creates a new project access token.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/#create-a-project-access-token

func (*ProjectAccessTokensService) GetProjectAccessToken added in v0.116.0 

func (s *ProjectAccessTokensService) GetProjectAccessToken(pid any, id int64, options ...RequestOptionFunc) (*ProjectAccessToken, *Response, error)

GetProjectAccessToken gets a single project access tokens in a project.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/#get-details-on-a-project-access-token

func (*ProjectAccessTokensService) ListProjectAccessTokens added in v0.116.0 

func (s *ProjectAccessTokensService) ListProjectAccessTokens(pid any, opt *ListProjectAccessTokensOptions, options ...RequestOptionFunc) ([]*ProjectAccessToken, *Response, error)

ListProjectAccessTokens gets a list of all project access tokens in a project.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/#list-all-project-access-tokens

func (*ProjectAccessTokensService) RevokeProjectAccessToken added in v0.116.0 

func (s *ProjectAccessTokensService) RevokeProjectAccessToken(pid any, id int64, options ...RequestOptionFunc) (*Response, error)

RevokeProjectAccessToken revokes a project access token.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/#revoke-a-project-access-token

func (*ProjectAccessTokensService) RotateProjectAccessToken added in v0.116.0 

func (s *ProjectAccessTokensService) RotateProjectAccessToken(pid any, id int64, opt *RotateProjectAccessTokenOptions, options ...RequestOptionFunc) (*ProjectAccessToken, *Response, error)

RotateProjectAccessToken revokes a project access token and returns a new project access token that expires in one week per default.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/#rotate-a-project-access-token

func (*ProjectAccessTokensService) RotateProjectAccessTokenSelf added in v0.127.0 

func (s *ProjectAccessTokensService) RotateProjectAccessTokenSelf(pid any, opt *RotateProjectAccessTokenOptions, options ...RequestOptionFunc) (*ProjectAccessToken, *Response, error)

RotateProjectAccessTokenSelf revokes the project access token used for the request and returns a new project access token that expires in one week per default.

GitLab API docs: https://docs.gitlab.com/api/project_access_tokens/#self-rotate

type ProjectAccessTokensServiceInterface added in v0.126.0 

type ProjectAccessTokensServiceInterface interface {
	ListProjectAccessTokens(pid any, opt *ListProjectAccessTokensOptions, options ...RequestOptionFunc) ([]*ProjectAccessToken, *Response, error)
	GetProjectAccessToken(pid any, id int64, options ...RequestOptionFunc) (*ProjectAccessToken, *Response, error)
	CreateProjectAccessToken(pid any, opt *CreateProjectAccessTokenOptions, options ...RequestOptionFunc) (*ProjectAccessToken, *Response, error)
	RotateProjectAccessToken(pid any, id int64, opt *RotateProjectAccessTokenOptions, options ...RequestOptionFunc) (*ProjectAccessToken, *Response, error)
	RotateProjectAccessTokenSelf(pid any, opt *RotateProjectAccessTokenOptions, options ...RequestOptionFunc) (*ProjectAccessToken, *Response, error)
	RevokeProjectAccessToken(pid any, id int64, options ...RequestOptionFunc) (*Response, error)
}

type ProjectAlias added in v0.150.0 

type ProjectAlias struct {
	ID        int64  `json:"id"`
	ProjectID int64  `json:"project_id"`
	Name      string `json:"name"`
}

ProjectAlias represents a GitLab project alias.

GitLab API docs: https://docs.gitlab.com/api/project_aliases/

type ProjectAliasesService added in v0.150.0 

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

ProjectAliasesService handles communication with the project aliases related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/project_aliases/

func (*ProjectAliasesService) CreateProjectAlias added in v0.150.0 

func (s *ProjectAliasesService) CreateProjectAlias(opt *CreateProjectAliasOptions, options ...RequestOptionFunc) (*ProjectAlias, *Response, error)

CreateProjectAlias creates a new project alias.

GitLab API docs: https://docs.gitlab.com/api/project_aliases/#create-a-project-alias

func (*ProjectAliasesService) DeleteProjectAlias added in v0.150.0 

func (s *ProjectAliasesService) DeleteProjectAlias(name string, options ...RequestOptionFunc) (*Response, error)

DeleteProjectAlias deletes a project alias.

GitLab API docs: https://docs.gitlab.com/api/project_aliases/#delete-a-project-alias

func (*ProjectAliasesService) GetProjectAlias added in v0.150.0 

func (s *ProjectAliasesService) GetProjectAlias(name string, options ...RequestOptionFunc) (*ProjectAlias, *Response, error)

GetProjectAlias gets details of a project alias.

GitLab API docs: https://docs.gitlab.com/api/project_aliases/#get-project-alias-details

func (*ProjectAliasesService) ListProjectAliases added in v0.150.0 

func (s *ProjectAliasesService) ListProjectAliases(options ...RequestOptionFunc) ([]*ProjectAlias, *Response, error)

ListProjectAliases gets a list of all project aliases.

GitLab API docs: https://docs.gitlab.com/api/project_aliases/#list-all-project-aliases

type ProjectAliasesServiceInterface added in v0.150.0 

type ProjectAliasesServiceInterface interface {
	ListProjectAliases(options ...RequestOptionFunc) ([]*ProjectAlias, *Response, error)
	GetProjectAlias(name string, options ...RequestOptionFunc) (*ProjectAlias, *Response, error)
	CreateProjectAlias(opt *CreateProjectAliasOptions, options ...RequestOptionFunc) (*ProjectAlias, *Response, error)
	DeleteProjectAlias(name string, options ...RequestOptionFunc) (*Response, error)
}

type ProjectApprovalRule added in v0.116.0 

type ProjectApprovalRule struct {
	ID                            int64              `json:"id"`
	Name                          string             `json:"name"`
	RuleType                      string             `json:"rule_type"`
	ReportType                    string             `json:"report_type"`
	EligibleApprovers             []*BasicUser       `json:"eligible_approvers"`
	ApprovalsRequired             int64              `json:"approvals_required"`
	Users                         []*BasicUser       `json:"users"`
	Groups                        []*Group           `json:"groups"`
	ContainsHiddenGroups          bool               `json:"contains_hidden_groups"`
	ProtectedBranches             []*ProtectedBranch `json:"protected_branches"`
	AppliesToAllProtectedBranches bool               `json:"applies_to_all_protected_branches"`
}

ProjectApprovalRule represents a GitLab project approval rule.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#get-all-approval-rules-for-project

func (ProjectApprovalRule) String added in v0.116.0 

func (s ProjectApprovalRule) String() string

type ProjectApprovals added in v0.116.0 

type ProjectApprovals struct {
	Approvers                                 []*MergeRequestApproverUser  `json:"approvers"`
	ApproverGroups                            []*MergeRequestApproverGroup `json:"approver_groups"`
	ResetApprovalsOnPush                      bool                         `json:"reset_approvals_on_push"`
	DisableOverridingApproversPerMergeRequest bool                         `json:"disable_overriding_approvers_per_merge_request"`
	MergeRequestsAuthorApproval               bool                         `json:"merge_requests_author_approval"`
	MergeRequestsDisableCommittersApproval    bool                         `json:"merge_requests_disable_committers_approval"`
	RequirePasswordToApprove                  bool                         `json:"require_password_to_approve"`
	SelectiveCodeOwnerRemovals                bool                         `json:"selective_code_owner_removals,omitempty"`

	// Deprecated: use Merge Request Approvals API instead
	ApprovalsBeforeMerge int64 `json:"approvals_before_merge"`
}

ProjectApprovals represents GitLab project level merge request approvals.

GitLab API docs: https://docs.gitlab.com/api/merge_request_approvals/#project-approval-rules

type ProjectAvatar added in v0.116.0 

type ProjectAvatar struct {
	Filename string
	Image    io.Reader
}

ProjectAvatar represents a GitLab project avatar.

GitLab API docs: https://docs.gitlab.com/api/projects/#create-a-project

func (*ProjectAvatar) MarshalJSON added in v0.116.0 

func (a *ProjectAvatar) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

type ProjectBadge added in v0.11.1 

type ProjectBadge struct {
	ID               int64  `json:"id"`
	Name             string `json:"name"`
	LinkURL          string `json:"link_url"`
	ImageURL         string `json:"image_url"`
	RenderedLinkURL  string `json:"rendered_link_url"`
	RenderedImageURL string `json:"rendered_image_url"`
	// Kind represents a project badge kind. Can be empty, when used PreviewProjectBadge().
	Kind string `json:"kind"`
}

ProjectBadge represents a project badge.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#list-all-badges-of-a-project

type ProjectBadgePreviewOptions added in v0.11.1 

type ProjectBadgePreviewOptions struct {
	LinkURL  *string `url:"link_url,omitempty" json:"link_url,omitempty"`
	ImageURL *string `url:"image_url,omitempty" json:"image_url,omitempty"`
}

ProjectBadgePreviewOptions represents the available PreviewProjectBadge() options.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#preview-a-badge-from-a-project

type ProjectBadgesService added in v0.11.1 

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

ProjectBadgesService handles communication with the project badges related methods of the GitLab API.

GitLab API docs: https://docs.gitlab.com/api/project_badges/

func (*ProjectBadgesService) AddProjectBadge added in v0.11.1 

func (s *ProjectBadgesService) AddProjectBadge(pid any, opt *AddProjectBadgeOptions, options ...RequestOptionFunc) (*ProjectBadge, *Response, error)

AddProjectBadge adds a badge to a project.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#add-a-badge-to-a-project

func (*ProjectBadgesService) DeleteProjectBadge added in v0.11.1 

func (s *ProjectBadgesService) DeleteProjectBadge(pid any, badge int64, options ...RequestOptionFunc) (*Response, error)

DeleteProjectBadge removes a badge from a project. Only project's badges will be removed by using this endpoint.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#remove-a-badge-from-a-project

func (*ProjectBadgesService) EditProjectBadge added in v0.11.1 

func (s *ProjectBadgesService) EditProjectBadge(pid any, badge int64, opt *EditProjectBadgeOptions, options ...RequestOptionFunc) (*ProjectBadge, *Response, error)

EditProjectBadge updates a badge of a project.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#edit-a-badge-of-a-project

func (*ProjectBadgesService) GetProjectBadge added in v0.11.1 

func (s *ProjectBadgesService) GetProjectBadge(pid any, badge int64, options ...RequestOptionFunc) (*ProjectBadge, *Response, error)

GetProjectBadge gets a project badge.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#get-a-badge-of-a-project

func (*ProjectBadgesService) ListProjectBadges added in v0.11.1 

func (s *ProjectBadgesService) ListProjectBadges(pid any, opt *ListProjectBadgesOptions, options ...RequestOptionFunc) ([]*ProjectBadge, *Response, error)

ListProjectBadges gets a list of a project's badges and its group badges.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#list-all-badges-of-a-project

func (*ProjectBadgesService) PreviewProjectBadge added in v0.11.1 

func (s *ProjectBadgesService) PreviewProjectBadge(pid any, opt *ProjectBadgePreviewOptions, options ...RequestOptionFunc) (*ProjectBadge, *Response, error)

PreviewProjectBadge returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.

GitLab API docs: https://docs.gitlab.com/api/project_badges/#preview-a-badge-from-a-project

type ProjectBadgesServiceInterface added in v0.126.0 

type ProjectBadgesServiceInterface interface {
	ListProjectBadges(pid any, opt *ListProjectBadgesOptions, options ...RequestOptionFunc) ([]*ProjectBadge, *Response, error)
	GetProjectBadge(pid any, badge int64, options ...RequestOptionFunc) (*ProjectBadge, *Response, error)
	AddProjectBadge(pid any, opt *AddProjectBadgeOptions, options ...RequestOptionFunc) (*ProjectBadge, *Response, error)
	EditProjectBadge(pid any, badge int64, opt *EditProjectBadgeOptions, options ...RequestOptionFunc) (*ProjectBadge, *Response, error)
	DeleteProjectBadge(pid any, badge int64, options ...RequestOptionFunc) (*Response, error)
	PreviewProjectBadge(pid any, opt *ProjectBadgePreviewOptions, options ...RequestOptionFunc) (*ProjectBadge, *Response, error)
}

type ProjectCluster added in v0.116.0 

type ProjectCluster struct {
	ID                 int64               `json:"id"`
	Name               string              `json:"name"`
	Domain             string              `json:"domain"`
	CreatedAt          *time.Time          `json:"created_at"`
	ProviderType       string              `json:"provider_type"`
	PlatformType       string              `json:"platform_type"`
	EnvironmentScope   string              `json:"environment_scope"`
	ClusterType        string              `json:"cluster_type"`
	User               *User               `json:"user"`
	PlatformKubernetes *PlatformKubernetes `json:"platform_kubernetes"`
	ManagementProject  *ManagementProject  `json:"management_project"`
	Project            *Project            `json:"project"`
}

ProjectCluster represents a GitLab Project Cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/project_clusters/

func (ProjectCluster) String deprecated added in v0.116.0 

func (v ProjectCluster) String() string

Deprecated: in GitLab 14.5, to be removed in 19.0

type ProjectClustersService added in v0.116.0 

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

ProjectClustersService handles communication with the project clusters related methods of the GitLab API. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/project_clusters/

func (*ProjectClustersService) AddCluster added in v0.116.0 

func (s *ProjectClustersService) AddCluster(pid any, opt *AddClusterOptions, options ...RequestOptionFunc) (*ProjectCluster, *Response, error)

AddCluster adds an existing cluster to the project. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/project_clusters/#add-existing-cluster-to-project

func (*ProjectClustersService) DeleteCluster added in v0.116.0 

func (s *ProjectClustersService) DeleteCluster(pid any, cluster int64, options ...RequestOptionFunc) (*Response, error)

DeleteCluster deletes an existing project cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/project_clusters/#delete-project-cluster

func (*ProjectClustersService) EditCluster added in v0.116.0 

func (s *ProjectClustersService) EditCluster(pid any, cluster int64, opt *EditClusterOptions, options ...RequestOptionFunc) (*ProjectCluster, *Response, error)

EditCluster updates an existing project cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/project_clusters/#edit-project-cluster

func (*ProjectClustersService) GetCluster added in v0.116.0 

func (s *ProjectClustersService) GetCluster(pid any, cluster int64, options ...RequestOptionFunc) (*ProjectCluster, *Response, error)

GetCluster gets a cluster. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/project_clusters/#get-a-single-project-cluster

func (*ProjectClustersService) ListClusters added in v0.116.0 

func (s *ProjectClustersService) ListClusters(pid any, options ...RequestOptionFunc) ([]*ProjectCluster, *Response, error)

ListClusters gets a list of all clusters in a project. Deprecated: in GitLab 14.5, to be removed in 19.0

GitLab API docs: https://docs.gitlab.com/api/project_clusters/#list-project-clusters

type ProjectClustersServiceInterface deprecated added in v0.126.0 

type ProjectClustersServiceInterface interface {
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	ListClusters(pid any, options ...RequestOptionFunc) ([]*ProjectCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	GetCluster(pid any, cluster int64, options ...RequestOptionFunc) (*ProjectCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	AddCluster(pid any, opt *AddClusterOptions, options ...RequestOptionFunc) (*ProjectCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	EditCluster(pid any, cluster int64, opt *EditClusterOptions, options ...RequestOptionFunc) (*ProjectCluster, *Response, error)
	// Deprecated: in GitLab 14.5, to be removed in 19.0
	DeleteCluster(pid any, cluster int64, options ...RequestOptionFunc) (*Response, error)
}

Deprecated: in GitLab 14.5, to be removed in 19.0

type ProjectCreationLevelValue added in v0.116.0 

type ProjectCreationLevelValue string

ProjectCreationLevelValue represents a project creation level within GitLab.

GitLab API docs: https://docs.gitlab.com/api/groups/ 

const (
	NoOneProjectCreation         ProjectCreationLevelValue = "noone"
	MaintainerProjectCreation    ProjectCreationLevelValue = "maintainer"
	DeveloperProjectCreation     ProjectCreationLevelValue = "developer"
	OwnerProjectCreation         ProjectCreationLevelValue = "owner"
	AdministratorProjectCreation ProjectCreationLevelValue = "administrator"
)

List of available project creation levels.

GitLab API docs: https://docs.gitlab.com/api/groups/

type ProjectDeployKey added in v0.116.0 

type ProjectDeployKey struct {
	ID                int64      `json:"id"`
	Title             string     `json:"title"`
	Key               string     `json:"key"`
	Fingerprint       string     `json:"fingerprint"`
	FingerprintSHA256 string     `json:"fingerprint_sha256"`
	CreatedAt         *time.Time `json:"created_at"`
	CanPush           bool       `json:"can_push"`
	ExpiresAt         *time.Time `json:"expires_at"`
}

ProjectDeployKey represents a GitLab project deploy key.

func (ProjectDeployKey) String added in v0.116.0 

func (k ProjectDeployKey) String() string

type ProjectEvent 

type ProjectEvent struct {
	ID             int64                `json:"id"`
	Title          string               `json:"title"`
	ProjectID      int64                `json:"project_id"`
	ActionName     string               `json:"action_name"`
	TargetID       int64                `json:"target_id"`
	TargetIID      int64                `json:"target_iid"`
	TargetType     string               `json:"target_type"`
	AuthorID       int64                `json:"author_id"`
	TargetTitle    string               `json:"target_title"`
	CreatedAt      string               `json:"created_at"`
	Author         BasicUser            `json:"author"`
	AuthorUsername string               `json:"author_username"`
	Data           ProjectEventData     `json:"data"`
	Note           ProjectEventNote     `json:"note"`
	PushData       ProjectEventPushData `json:"push_data"`
}

ProjectEvent represents a GitLab project event.

GitLab API docs: https://docs.gitlab.com/api/events/#list-all-visible-events-for-a-project

func (ProjectEvent) String 

func (s ProjectEvent) String() string

type ProjectEventData added in v1.0.0 

type ProjectEventData struct {
	Before            string      `json:"before"`
	After             string      `json:"after"`
	Ref               string      `json:"ref"`
	UserID            int64       `json:"user_id"`
	UserName          string      `json:"user_name"`
	Repository        *Repository `json:"repository"`
	Commits           []*Commit   `json:"commits"`
	TotalCommitsCount int64       `json:"total_commits_count"`
}

ProjectEventData represents the GitLab project event data.

GitLab API docs: https://docs.gitlab.com/api/events/#list-all-visible-events-for-a-project

func (ProjectEventData) String added in v1.0.0 

func (d ProjectEventData) String() string

type ProjectEventNote added in v1.0.0 

type ProjectEventNote struct {
	ID           int64                  `json:"id"`
	Body         string                 `json:"body"`
	Attachment   string                 `json:"attachment"`
	Author       ProjectEventNoteAuthor `json:"author"`
	CreatedAt    *time.Time             `json:"created_at"`
	System       bool                   `json:"system"`
	NoteableID   int64                  `json:"noteable_id"`
	NoteableType string                 `json:"noteable_type"`
	NoteableIID  int64                  `json:"noteable_iid"`
}

ProjectEventNote represents a GitLab project event note.

GitLab API docs: https://docs.gitlab.com/api/events/#list-all-visible-events-for-a-project

func (ProjectEventNote) String added in v1.0.0 

func (n ProjectEventNote) String() string

type ProjectEventNoteAuthor added in v1.0.0 

type ProjectEventNoteAuthor struct {
	ID        int64  `json:"id"`
	Username  string `json:"username"`
	Email     string `json:"email"`
	Name      string `json:"name"`
	State     string `json:"state"`
	AvatarURL string `json:"avatar_url"`
	WebURL    string `json:"web_url"`
}

ProjectEventNoteAuthor represents a GitLab project event note author.

GitLab API docs: https://docs.gitlab.com/api/events/#list-all-visible-events-for-a-project

func (ProjectEventNoteAuthor) String added in v1.0.0 

func (a ProjectEventNoteAuthor) String() string

type ProjectEventOwner added in v1.20.0 

type ProjectEventOwner struct {
	Name  string `json:"name"`
	Email string `json:"email"`
}

type ProjectEventPushData added in v1.0.0 

type ProjectEventPushData struct {
	CommitCount int64  `json:"commit_count"`
	Action      string `json:"action"`
	RefType     string `json:"ref_type"`
	CommitFrom  string `json:"commit_from"`
	CommitTo    string `json:"commit_to"`
	Ref         string `json:"ref"`
	CommitTitle string `json:"commit_title"`
}

ProjectEventPushData represents a GitLab project event push data.

GitLab API docs: https://docs.gitlab.com/api/events/#list-all-visible-events-for-a-project

func (ProjectEventPushData) String added in v1.0.0 

func (d ProjectEventPushData) String() string

type ProjectFeatureFlag added in v0.116.0 

type ProjectFeatureFlag struct {
	Name        string                        `json:"name"`
	Description string                        `json:"description"`
	Active      bool                          `json:"active"`
	Version     string                        `json:"version"`
	CreatedAt   *time.Time                    `json:"created_at"`
	UpdatedAt   *time.Time                    `json:"updated_at"`
	Scopes      []*ProjectFeatureFlagScope    `json:"scopes"`
	Strategies  []*ProjectFeatureFlagStrategy `json:"strategies"`
}

ProjectFeatureFlag represents a GitLab project iteration.

GitLab API docs: https://docs.gitlab.com/api/feature_flags/

func (ProjectFeatureFlag) String added in v0.116.0 

func (i ProjectFeatureFlag) String() string

type ProjectFeatureFlagScope added in v0.116.0 

type ProjectFeatureFlagScope struct {
	ID               int64  `json:"id"`
	EnvironmentScope string `json:"environment_scope"`
}

ProjectFeatureFlagScope defines the scopes of a feature flag

GitLab API docs: https://docs.gitlab.com/api/feature_flags/

type ProjectFeatureFlagScopeOptions added in v0.116.0 

type ProjectFeatureFlagScopeOptions struct {
	ID               *int64  `url:"id,omitempty" json:"id,omitempty"`
	EnvironmentScope *string `url:"id,omitempty" json:"environment_scope,omitempty"`
}

ProjectFeatureFlagScopeOptions represents the available feature flag scope options.

GitLab API docs: https://docs.gitlab.com/api/feature_flags/#create-a-feature-flag

type ProjectFeatureFlagService added in v0.116.0 

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

ProjectFeatureFlagService handles operations on gitlab project feature flags using the following api:

GitLab API docs: https://docs.gitlab.com/api/feature_flags/

func (*ProjectFeatureFlagService) CreateProjectFeatureFlag added in v0.116.0 

func (s *ProjectFeatureFlagService) CreateProjectFeatureFlag(pid any, opt *CreateProjectFeatureFlagOptions, options ...RequestOptionFunc) (*ProjectFeatureFlag, *Response, error)

func (*ProjectFeatureFlagService) DeleteProjectFeatureFlag added in v0.116.0 

func (s *ProjectFeatureFlagService) DeleteProjectFeatureFlag(pid any, name string, options ...RequestOptionFunc) (*Response, error)

func (*ProjectFeatureFlagService) GetProjectFeatureFlag added in v0.116.0 

func (s *ProjectFeatureFlagService) GetProjectFeatureFlag(pid any, name string, options ...RequestOptionFunc) (*ProjectFeatureFlag, *Response, error)

func (*ProjectFeatureFlagService) ListProjectFeatureFlags added in v0.116.0 

func (s *ProjectFeatureFlagService) ListProjectFeatureFlags(pid any, opt *ListProjectFeatureFlagOptions, options ...RequestOptionFunc) ([]*ProjectFeatureFlag, *Response, error)

func (*ProjectFeatureFlagService) UpdateProjectFeatureFlag added in v0.116.0 

func (s *ProjectFeatureFlagService) UpdateProjectFeatureFlag(pid any, name string, opt *UpdateProjectFeatureFlagOptions, options ...RequestOptionFunc) (*ProjectFeatureFlag, *Response, error)

type ProjectFeatureFlagServiceInterface added in v0.126.0 

type ProjectFeatureFlagServiceInterface interface {
	// ListProjectFeatureFlags returns a list with the feature flags of a project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/feature_flags/#list-feature-flags-for-a-project
	ListProjectFeatureFlags(pid any, opt *ListProjectFeatureFlagOptions, options ...RequestOptionFunc) ([]*ProjectFeatureFlag, *Response, error)
	// GetProjectFeatureFlag gets a single feature flag for the specified project.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/feature_flags/#get-a-single-feature-flag
	GetProjectFeatureFlag(pid any, name string, options ...RequestOptionFunc) (*ProjectFeatureFlag, *Response, error)
	// CreateProjectFeatureFlag creates a feature flag.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/feature_flags/#create-a-feature-flag
	CreateProjectFeatureFlag(pid any, opt *CreateProjectFeatureFlagOptions, options ...RequestOptionFunc) (*ProjectFeatureFlag, *Response, error)
	// UpdateProjectFeatureFlag updates a feature flag.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/feature_flags/#update-a-feature-flag
	UpdateProjectFeatureFlag(pid any, name string, opt *UpdateProjectFeatureFlagOptions, options ...RequestOptionFunc) (*ProjectFeatureFlag, *Response, error)
	// DeleteProjectFeatureFlag deletes a feature flag.
	//
	// GitLab API docs:
	// https://docs.gitlab.com/api/feature_flags/#delete-a-feature-flag
	DeleteProjectFeatureFlag(pid any, name string, options ...RequestOptionFunc) (*Response, error)
}

type ProjectFeatureFlagStrategy added in v0.116.0 

type ProjectFeatureFlagStrategy struct {
	ID         int64                                `json:"id"`
	Name       string                               `json:"name"`
	Parameters *ProjectFeatureFlagStrategyParameter `json:"parameters"`
	Scopes     []*ProjectFeatureFlagScope           `json:"scopes"`
}

ProjectFeatureFlagStrategy defines the strategy used for a feature flag

GitLab API docs: https://docs.gitlab.com/api/feature_flags/

type ProjectFeatureFlagStrategyParameter added in v0.116.0 

type ProjectFeatureFlagStrategyParameter struct {
	GroupID    string `json:"groupId,omitempty"`
	UserIDs    string `json:"userIds,omitempty"`
	Percentage string `json:"percentage,omitempty"`

	// Following fields aren't documented in GitLab API docs,
	// but are present in GitLab API since 13.5.
	// Docs: https://docs.getunleash.io/reference/activation-strategies#gradual-rollout
	Rollout    string `json:"rollout,omitempty"`
	Stickiness string `json:"stickiness,omitempty"`
}

ProjectFeatureFlagStrategyParameter is used in updating and creating feature flags

GitLab API docs: https://docs.gitlab.com/api/feature_flags/

type ProjectForkRelation 

type ProjectForkRelation struct {
	ID                  int64      `json:"id"`
	ForkedToProjectID   int64      `json:"forked_to_project_id"`
	ForkedFromProjectID int64      `json:"forked_from_project_id"`
	CreatedAt           *time.Time `json:"created_at"`
	UpdatedAt           *time.Time `json:"updated_at"`
}

ProjectForkRelation represents a project fork relationship.

GitLab API docs: https://docs.gitlab.com/api/project_forks/#create-a-fork-relationship-between-projects

type ProjectGroup added in v0.116.0 

type ProjectGroup struct {
	ID        int64  `json:"id"`
	Name      string `json:"name"`
	AvatarURL string `json:"avatar_url"`
	WebURL    string `json:"web_url"`
	FullName  string `json:"full_name"`
	FullPath  string `json:"full_path"`
}

ProjectGroup represents a GitLab project group. GitLab API docs: https://docs.gitlab.com/api/projects/#list-groups

type ProjectHook 

type ProjectHook struct {
	ID                        int64               `json:"id"`
	URL                       string              `json:"url"`
	Name                      string              `json:"name"`
	Description               string              `json:"description"`
	ProjectID                 int64               `json:"project_id"`
	PushEvents                bool                `json:"push_events"`
	PushEventsBranchFilter    string              `json:"push_events_branch_filter"`
	IssuesEvents              bool                `json:"issues_events"`
	ConfidentialIssuesEvents  bool                `json:"confidential_issues_events"`
	MergeRequestsEvents       bool                `json:"merge_requests_events"`
	TagPushEvents             bool                `json:"tag_push_events"`
	NoteEvents                bool                `json:"note_events"`
	ConfidentialNoteEvents    bool                `json:"confidential_note_events"`
	JobEvents                 bool                `json:"job_events"`
	PipelineEvents            bool                `json:"pipeline_events"`
	WikiPageEvents            bool                `json:"wiki_page_events"`
	DeploymentEvents          bool                `json:"deployment_events"`
	ReleasesEvents            bool                `json:"releases_events"`
	MilestoneEvents           bool                `json:"milestone_events"`
	FeatureFlagEvents         bool                `json:"feature_flag_events"`
	EmojiEvents               bool                `json:"emoji_events"`
	EnableSSLVerification     bool                `json:"enable_ssl_verification"`
	RepositoryUpdateEvents    bool                `json:"repository_update_events"`
	AlertStatus               string              `json:"alert_status"`
	DisabledUntil             *time.Time          `json:"disabled_until"`
	URLVariables              []HookURLVariable   `json:"url_variables"`
	CreatedAt                 *time.Time          `json:"created_at"`
	ResourceAccessTokenEvents bool                `json:"resource_access_token_events"`
	CustomWebhookTemplate     string              `json:"custom_webhook_template"`
	CustomHead