wiki

type Client interface {
	// [Preview API] Creates an attachment in the wiki.
	CreateAttachment(context.Context, CreateAttachmentArgs) (*WikiAttachmentResponse, error)
	// [Preview API] Creates or edits a wiki page.
	CreateOrUpdatePage(context.Context, CreateOrUpdatePageArgs) (*WikiPageResponse, error)
	// [Preview API] Creates a page move operation that updates the path and order of the page as provided in the parameters.
	CreatePageMove(context.Context, CreatePageMoveArgs) (*WikiPageMoveResponse, error)
	// [Preview API] Creates the wiki resource.
	CreateWiki(context.Context, CreateWikiArgs) (*WikiV2, error)
	// [Preview API] Deletes a wiki page.
	DeletePage(context.Context, DeletePageArgs) (*WikiPageResponse, error)
	// [Preview API] Deletes a wiki page.
	DeletePageById(context.Context, DeletePageByIdArgs) (*WikiPageResponse, error)
	// [Preview API] Deletes the wiki corresponding to the wiki ID or wiki name provided.
	DeleteWiki(context.Context, DeleteWikiArgs) (*WikiV2, error)
	// [Preview API] Gets all wikis in a project or collection.
	GetAllWikis(context.Context, GetAllWikisArgs) (*[]WikiV2, error)
	// [Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.
	GetPage(context.Context, GetPageArgs) (*WikiPageResponse, error)
	// [Preview API] Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageById(context.Context, GetPageByIdArgs) (*WikiPageResponse, error)
	// [Preview API] Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageByIdText(context.Context, GetPageByIdTextArgs) (io.ReadCloser, error)
	// [Preview API] Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageByIdZip(context.Context, GetPageByIdZipArgs) (io.ReadCloser, error)
	// [Preview API] Returns page detail corresponding to Page ID.
	GetPageData(context.Context, GetPageDataArgs) (*WikiPageDetail, error)
	// [Preview API] Returns pageable list of Wiki Pages
	GetPagesBatch(context.Context, GetPagesBatchArgs) (*GetPagesBatchResponseValue, error)
	// [Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageText(context.Context, GetPageTextArgs) (io.ReadCloser, error)
	// [Preview API] Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the `Accept` header sent in the request.
	GetPageZip(context.Context, GetPageZipArgs) (io.ReadCloser, error)
	// [Preview API] Gets the wiki corresponding to the wiki ID or wiki name provided.
	GetWiki(context.Context, GetWikiArgs) (*WikiV2, error)
	// [Preview API] Edits a wiki page.
	UpdatePageById(context.Context, UpdatePageByIdArgs) (*WikiPageResponse, error)
	// [Preview API] Updates the wiki corresponding to the wiki ID or wiki name provided using the update parameters.
	UpdateWiki(context.Context, UpdateWikiArgs) (*WikiV2, error)
}

type ClientImpl struct {
	Client azuredevops.Client
}

type CreateAttachmentArgs struct {
	// (required) Stream to upload
	UploadStream io.Reader
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (required) Wiki attachment name.
	Name *string
	// (optional) GitVersionDescriptor for the page. (Optional in case of ProjectWiki).
	VersionDescriptor *git.GitVersionDescriptor
}

type CreateOrUpdatePageArgs struct {
	// (required) Wiki create or update operation parameters.
	Parameters *WikiPageCreateOrUpdateParameters
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (required) Wiki page path.
	Path *string
	// (required) Version of the page on which the change is to be made. Mandatory for `Edit` scenario. To be populated in the If-Match header of the request.
	Version *string
	// (optional) Comment to be associated with the page operation.
	Comment *string
	// (optional) GitVersionDescriptor for the page. (Optional in case of ProjectWiki).
	VersionDescriptor *git.GitVersionDescriptor
}

type CreatePageMoveArgs struct {
	// (required) Page more operation parameters.
	PageMoveParameters *WikiPageMoveParameters
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (optional) Comment that is to be associated with this page move.
	Comment *string
	// (optional) GitVersionDescriptor for the page. (Optional in case of ProjectWiki).
	VersionDescriptor *git.GitVersionDescriptor
}

type CreateWikiArgs struct {
	// (required) Parameters for the wiki creation.
	WikiCreateParams *WikiCreateParametersV2
	// (optional) Project ID or project name
	Project *string
}

type DeletePageArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (required) Wiki page path.
	Path *string
	// (optional) Comment to be associated with this page delete.
	Comment *string
	// (optional) GitVersionDescriptor for the page. (Optional in case of ProjectWiki).
	VersionDescriptor *git.GitVersionDescriptor
}

type DeletePageByIdArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (required) Wiki page ID.
	Id *int
	// (optional) Comment to be associated with this page delete.
	Comment *string
}

type DeleteWikiArgs struct {
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (optional) Project ID or project name
	Project *string
}

type GetAllWikisArgs struct {
	// (optional) Project ID or project name
	Project *string
}

type GetPageArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (optional) Wiki page path.
	Path *string
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) GitVersionDescriptor for the page. Defaults to the default branch (Optional).
	VersionDescriptor *git.GitVersionDescriptor
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

type GetPageByIdArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name..
	WikiIdentifier *string
	// (required) Wiki page ID.
	Id *int
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

type GetPageByIdTextArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name..
	WikiIdentifier *string
	// (required) Wiki page ID.
	Id *int
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

type GetPageByIdZipArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name..
	WikiIdentifier *string
	// (required) Wiki page ID.
	Id *int
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

type GetPageDataArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (required) Wiki page ID.
	PageId *int
	// (optional) last N days from the current day for which page views is to be returned. It's inclusive of current day.
	PageViewsForDays *int
}

type GetPageTextArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (optional) Wiki page path.
	Path *string
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) GitVersionDescriptor for the page. Defaults to the default branch (Optional).
	VersionDescriptor *git.GitVersionDescriptor
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

type GetPageZipArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (optional) Wiki page path.
	Path *string
	// (optional) Recursion level for subpages retrieval. Defaults to `None` (Optional).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) GitVersionDescriptor for the page. Defaults to the default branch (Optional).
	VersionDescriptor *git.GitVersionDescriptor
	// (optional) True to include the content of the page in the response for Json content type. Defaults to false (Optional)
	IncludeContent *bool
}

type GetPagesBatchArgs struct {
	// (required) Wiki batch page request.
	PagesBatchRequest *WikiPagesBatchRequest
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (optional) GitVersionDescriptor for the page. (Optional in case of ProjectWiki).
	VersionDescriptor *git.GitVersionDescriptor
}

type GetPagesBatchResponseValue struct {
	Value             []WikiPageDetail
	ContinuationToken string
}

type GetWikiArgs struct {
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (optional) Project ID or project name
	Project *string
}

type UpdatePageByIdArgs struct {
	// (required) Wiki update operation parameters.
	Parameters *WikiPageCreateOrUpdateParameters
	// (required) Project ID or project name
	Project *string
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (required) Wiki page ID.
	Id *int
	// (required) Version of the page on which the change is to be made. Mandatory for `Edit` scenario. To be populated in the If-Match header of the request.
	Version *string
	// (optional) Comment to be associated with the page operation.
	Comment *string
}

type UpdateWikiArgs struct {
	// (required) Update parameters.
	UpdateParameters *WikiUpdateParameters
	// (required) Wiki ID or wiki name.
	WikiIdentifier *string
	// (optional) Project ID or project name
	Project *string
}

type Wiki struct {
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// The head commit associated with the git repository backing up the wiki.
	HeadCommit *string `json:"headCommit,omitempty"`
	// The ID of the wiki which is same as the ID of the Git repository that it is backed by.
	Id *uuid.UUID `json:"id,omitempty"`
	// The git repository that backs up the wiki.
	Repository *git.GitRepository `json:"repository,omitempty"`
}

type WikiAttachment struct {
	// Name of the wiki attachment file.
	Name *string `json:"name,omitempty"`
	// Path of the wiki attachment file.
	Path *string `json:"path,omitempty"`
}

type WikiAttachmentResponse struct {
	// Defines properties for wiki attachment file.
	Attachment *WikiAttachment `json:"attachment,omitempty"`
	// Contains the list of ETag values from the response header of the attachments API call. The first item in the list contains the version of the wiki attachment.
	ETag *[]string `json:"eTag,omitempty"`
}

type WikiCreateBaseParameters struct {
	// Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type.
	MappedPath *string `json:"mappedPath,omitempty"`
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// ID of the git repository that backs up the wiki. Not required for ProjectWiki type.
	RepositoryId *uuid.UUID `json:"repositoryId,omitempty"`
	// Type of the wiki.
	Type *WikiType `json:"type,omitempty"`
}

type WikiCreateParameters struct {
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
}

type WikiCreateParametersV2 struct {
	// Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type.
	MappedPath *string `json:"mappedPath,omitempty"`
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// ID of the git repository that backs up the wiki. Not required for ProjectWiki type.
	RepositoryId *uuid.UUID `json:"repositoryId,omitempty"`
	// Type of the wiki.
	Type *WikiType `json:"type,omitempty"`
	// Version of the wiki. Not required for ProjectWiki type.
	Version *git.GitVersionDescriptor `json:"version,omitempty"`
}

type WikiPage struct {
	// Content of the wiki page.
	Content *string `json:"content,omitempty"`
	// Path of the git item corresponding to the wiki page stored in the backing Git repository.
	GitItemPath *string `json:"gitItemPath,omitempty"`
	// When present, permanent identifier for the wiki page
	Id *int `json:"id,omitempty"`
	// True if a page is non-conforming, i.e. 1) if the name doesn't match page naming standards. 2) if the page does not have a valid entry in the appropriate order file.
	IsNonConformant *bool `json:"isNonConformant,omitempty"`
	// True if this page has subpages under its path.
	IsParentPage *bool `json:"isParentPage,omitempty"`
	// Order of the wiki page, relative to other pages in the same hierarchy level.
	Order *int `json:"order,omitempty"`
	// Path of the wiki page.
	Path *string `json:"path,omitempty"`
	// Remote web url to the wiki page.
	RemoteUrl *string `json:"remoteUrl,omitempty"`
	// List of subpages of the current page.
	SubPages *[]WikiPage `json:"subPages,omitempty"`
	// REST url for this wiki page.
	Url *string `json:"url,omitempty"`
}

type WikiPageCreateOrUpdateParameters struct {
	// Content of the wiki page.
	Content *string `json:"content,omitempty"`
}

type WikiPageDetail struct {
	// When present, permanent identifier for the wiki page
	Id *int `json:"id,omitempty"`
	// Path of the wiki page.
	Path *string `json:"path,omitempty"`
	// Path of the wiki page.
	ViewStats *[]WikiPageStat `json:"viewStats,omitempty"`
}

type WikiPageMove struct {
	// New order of the wiki page.
	NewOrder *int `json:"newOrder,omitempty"`
	// New path of the wiki page.
	NewPath *string `json:"newPath,omitempty"`
	// Current path of the wiki page.
	Path *string `json:"path,omitempty"`
	// Resultant page of this page move operation.
	Page *WikiPage `json:"page,omitempty"`
}

type WikiPageMoveParameters struct {
	// New order of the wiki page.
	NewOrder *int `json:"newOrder,omitempty"`
	// New path of the wiki page.
	NewPath *string `json:"newPath,omitempty"`
	// Current path of the wiki page.
	Path *string `json:"path,omitempty"`
}

type WikiPageMoveResponse struct {
	// Contains the list of ETag values from the response header of the page move API call. The first item in the list contains the version of the wiki page subject to page move.
	ETag *[]string `json:"eTag,omitempty"`
	// Defines properties for wiki page move.
	PageMove *WikiPageMove `json:"pageMove,omitempty"`
}

type WikiPageResponse struct {
	// Contains the list of ETag values from the response header of the pages API call. The first item in the list contains the version of the wiki page.
	ETag *[]string `json:"eTag,omitempty"`
	// Defines properties for wiki page.
	Page *WikiPage `json:"page,omitempty"`
}

type WikiPageStat struct {
	// the count of the stat for the Day
	Count *int `json:"count,omitempty"`
	// Day of the stat
	Day *azuredevops.Time `json:"day,omitempty"`
}

type WikiPageViewStats struct {
	// Wiki page view count.
	Count *int `json:"count,omitempty"`
	// Wiki page last viewed time.
	LastViewedTime *azuredevops.Time `json:"lastViewedTime,omitempty"`
	// Wiki page path.
	Path *string `json:"path,omitempty"`
}

type WikiPagesBatchRequest struct {
	// If the list of page data returned is not complete, a continuation token to query next batch of pages is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of Wiki Page Data.
	ContinuationToken *string `json:"continuationToken,omitempty"`
	// last N days from the current day for which page views is to be returned. It's inclusive of current day.
	PageViewsForDays *int `json:"pageViewsForDays,omitempty"`
	// Total count of pages on a wiki to return.
	Top *int `json:"top,omitempty"`
}

type WikiType string

type WikiUpdateParameters struct {
	// Name for wiki.
	Name *string `json:"name,omitempty"`
	// Versions of the wiki.
	Versions *[]git.GitVersionDescriptor `json:"versions,omitempty"`
}

type WikiUpdatedNotificationMessage struct {
	// Collection host Id for which the wikis are updated.
	CollectionId *uuid.UUID `json:"collectionId,omitempty"`
	// Project Id for which the wikis are updated.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// Repository Id associated with the particular wiki which is added, updated or deleted.
	RepositoryId *uuid.UUID `json:"repositoryId,omitempty"`
}

type WikiV2 struct {
	// Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type.
	MappedPath *string `json:"mappedPath,omitempty"`
	// Wiki name.
	Name *string `json:"name,omitempty"`
	// ID of the project in which the wiki is to be created.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// ID of the git repository that backs up the wiki. Not required for ProjectWiki type.
	RepositoryId *uuid.UUID `json:"repositoryId,omitempty"`
	// Type of the wiki.
	Type *WikiType `json:"type,omitempty"`
	// ID of the wiki.
	Id *uuid.UUID `json:"id,omitempty"`
	// Is wiki repository disabled
	IsDisabled *bool `json:"isDisabled,omitempty"`
	// Properties of the wiki.
	Properties *map[string]string `json:"properties,omitempty"`
	// Remote web url to the wiki.
	RemoteUrl *string `json:"remoteUrl,omitempty"`
	// REST url for this wiki.
	Url *string `json:"url,omitempty"`
	// Versions of the wiki.
	Versions *[]git.GitVersionDescriptor `json:"versions,omitempty"`
}