package internal

Import Path
	gitlab.com/pcanilho/go-jira-cli/internal (on go.dev)

Dependency Relation
	imports 12 packages, and imported by 2 packages

Involved Source Files

	      controller.go
	      controller_jira.go
	      controller_jira_board.go
	      controller_jira_issue.go
	      controller_jira_project.go
	      controller_jira_user.go
Package-Level Type Names (total 10, in which 7 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type BoardController (interface)

		Methods (total 2, both are exported)
			( T) GetBoard(string) (*jira.Board, error)
			( T) GetBoardIssues(string) ([]jira.Issue, error)
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*jiraController

	 type Controller (interface)

		Methods (total 10, all are exported)
			( T) AddCommentToIssue(interface{}, string) (*jira.Comment, error)
				AddCommentToIssue returns a instance pointer to a newly created Jira issue comment (@see *jira.Comment).
					An error is returned instead if the comment was not successfully added to the Jira issue.
					@param the instance pointer to a Jira issue or an identifier in string format representing either the issue key
						or internal ID.
					@param the comment body in string format to be added to the Jira issue.
					@return the instance pointer to the upstream *jira.Comment object for further manipulation.
					@return an error if the provided identifier does not match an existing issue or if the issue was not
						successfully updated with the new comment.

			( T) CloneIssue(interface{}) (*jira.Issue, error)
				CloneIssue creates a Jira issue using an existing issue as a base template. As a parameter, both the instance
					pointer and a ticket identifier (key or ID) can be provided.
					@return the instance pointer of the newly created Jira issue.
				 @return an error if the Jira issue was not successfully created.

			( T) CreateIssue(*IssueCreationOptions) (*jira.Issue, error)
				CreateIssue creates a Jira issue using the provided @param IssueCreationOptions object instance.
					@return the instance pointer of the newly created Jira issue.
				 @return an error if the Jira issue was not successfully created.

			( T) DeleteIssue(interface{}) error
				DeleteIssue deletes a Jira issue that matches the provided identifier.
					@param the instance pointer to a Jira issue or an identifier in string format representing either the issue key
						or internal ID.
					@return an error if the Jira issue was not deleted successfully.

			( T) GetIssue(string, *jira.GetQueryOptions) (*jira.Issue, error)
				GetIssue returns the pointer to a Jira issue instance that corresponds to the provided identifier (key or ID) in
						string format.
					@param the Jira issue identifier representing either the issue key or internal ID.
					@param the *jira.GetQueryOptions (based of the upstream `go-jira` library).
					@return the instance pointer of the Jira issue matching the provided identifier.
					@return an error if no Jira issue was found to be matching the provided identifier.

			( T) GetUser(string) (*jira.User, error)
			( T) SearchIssues(string, *jira.SearchOptions, int) ([]jira.Issue, error)
				SearchIssues searches for Jira issues with a provided JQL query in string format.
					@param the JQL query.
					@param the *jira.SearchOptions (based of the upstream `go-jira` library)
				 @param if greater than 0, an error will be returned whenever the search result is greater than the specified value.
						Useful when using piped commands. i.e. xargs, etc.
					@return a slice of Jira issues that match the provided JQL query.
				 @return an error if the provided JQL query is not valid.

			( T) SearchProjects(...string) ([]jira.Project, error)
			( T) UpdateIssue(interface{}, map[string]interface{}) (*jira.Issue, error)
				UpdateIssue returns the pointer of the newly updated Jira issue.
					@param the instance pointer to a Jira issue or an identifier in string format representing either the issue key
						or internal ID.
					@param the fields & properties of the provided Jira issue identifier that will be updated.
					@return the pointer of the newly updated Jira issue.
					@return an error if the provided identifier does not match an existing issue or if the issue was not
						successfully updated.

			( T) UploadAttachmentsToIssue(interface{}, ...*IssueAttachment) error
				UploadAttachmentsToIssue uploads/attaches files to the provided Jira issue. An error is returned instead if this
					process does not succeed.
					@param the instance pointer to a Jira issue or an identifier in string format representing either the issue key
						or internal ID.
					@param a variadic *IssueAttachment struct that represents a file path to be uploaded/attached to a Jira issue.
					@return an error if any of the provided files fail to be uploaded/attached to the Jira issue.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*jiraController
		Implements (at least 3, all are exported)
			 T : IssueController
			 T : ProjectController
			 T : UserController
		As Inputs Of (at least one exported)
			func gitlab.com/pcanilho/go-jira-cli/cmd/interactive.Menu.AttachController(controller Controller)
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var gitlab.com/pcanilho/go-jira-cli/cmd.jiraController

	 type IssueAttachment (struct)

		Fields (total 2, both are exported)
			Filename string
			Reader io.Reader
		Methods (only one, which is exported)
			( T) Read(p []byte) (n int, err error)
		Implements (at least one exported)
			 T : io.Reader
		As Outputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func gitlab.com/pcanilho/go-jira-cli/cmd.attachmentFromPath(path string) (*IssueAttachment, error)
			func gitlab.com/pcanilho/go-jira-cli/cmd.updateIssueAttributes(issue *jira.Issue) ([]*IssueAttachment, *helpers.ChangeLog, error)
		As Inputs Of (at least 2, both are exported)
			func Controller.UploadAttachmentsToIssue(interface{}, ...*IssueAttachment) error
			func IssueController.UploadAttachmentsToIssue(interface{}, ...*IssueAttachment) error

	 type IssueController (interface)

		Methods (total 8, all are exported)
			( T) AddCommentToIssue(interface{}, string) (*jira.Comment, error)
				AddCommentToIssue returns a instance pointer to a newly created Jira issue comment (@see *jira.Comment).
					An error is returned instead if the comment was not successfully added to the Jira issue.
					@param the instance pointer to a Jira issue or an identifier in string format representing either the issue key
						or internal ID.
					@param the comment body in string format to be added to the Jira issue.
					@return the instance pointer to the upstream *jira.Comment object for further manipulation.
					@return an error if the provided identifier does not match an existing issue or if the issue was not
						successfully updated with the new comment.

			( T) CloneIssue(interface{}) (*jira.Issue, error)
				CloneIssue creates a Jira issue using an existing issue as a base template. As a parameter, both the instance
					pointer and a ticket identifier (key or ID) can be provided.
					@return the instance pointer of the newly created Jira issue.
				 @return an error if the Jira issue was not successfully created.

			( T) CreateIssue(*IssueCreationOptions) (*jira.Issue, error)
				CreateIssue creates a Jira issue using the provided @param IssueCreationOptions object instance.
					@return the instance pointer of the newly created Jira issue.
				 @return an error if the Jira issue was not successfully created.

			( T) DeleteIssue(interface{}) error
				DeleteIssue deletes a Jira issue that matches the provided identifier.
					@param the instance pointer to a Jira issue or an identifier in string format representing either the issue key
						or internal ID.
					@return an error if the Jira issue was not deleted successfully.

			( T) GetIssue(string, *jira.GetQueryOptions) (*jira.Issue, error)
				GetIssue returns the pointer to a Jira issue instance that corresponds to the provided identifier (key or ID) in
						string format.
					@param the Jira issue identifier representing either the issue key or internal ID.
					@param the *jira.GetQueryOptions (based of the upstream `go-jira` library).
					@return the instance pointer of the Jira issue matching the provided identifier.
					@return an error if no Jira issue was found to be matching the provided identifier.

			( T) SearchIssues(string, *jira.SearchOptions, int) ([]jira.Issue, error)
				SearchIssues searches for Jira issues with a provided JQL query in string format.
					@param the JQL query.
					@param the *jira.SearchOptions (based of the upstream `go-jira` library)
				 @param if greater than 0, an error will be returned whenever the search result is greater than the specified value.
						Useful when using piped commands. i.e. xargs, etc.
					@return a slice of Jira issues that match the provided JQL query.
				 @return an error if the provided JQL query is not valid.

			( T) UpdateIssue(interface{}, map[string]interface{}) (*jira.Issue, error)
				UpdateIssue returns the pointer of the newly updated Jira issue.
					@param the instance pointer to a Jira issue or an identifier in string format representing either the issue key
						or internal ID.
					@param the fields & properties of the provided Jira issue identifier that will be updated.
					@return the pointer of the newly updated Jira issue.
					@return an error if the provided identifier does not match an existing issue or if the issue was not
						successfully updated.

			( T) UploadAttachmentsToIssue(interface{}, ...*IssueAttachment) error
				UploadAttachmentsToIssue uploads/attaches files to the provided Jira issue. An error is returned instead if this
					process does not succeed.
					@param the instance pointer to a Jira issue or an identifier in string format representing either the issue key
						or internal ID.
					@param a variadic *IssueAttachment struct that represents a file path to be uploaded/attached to a Jira issue.
					@return an error if any of the provided files fail to be uploaded/attached to the Jira issue.

		Implemented By (at least 2, in which 1 are exported)
			 Controller (interface)
			/* at least one unexported ... *//* at least one unexported: */
			*jiraController

	 type IssueCreationOptions (struct)

		Fields (total 11, all are exported)
			Assignee string
			Attachments []*IssueAttachment
			Comment string
			Components []string
			CustomFields tcontainer.MarshalMap
			Description string
			IssueType string
			Labels []string
			Priority string
			Project string
			Summary string
		As Inputs Of (at least 2, both are exported)
			func Controller.CreateIssue(*IssueCreationOptions) (*jira.Issue, error)
			func IssueController.CreateIssue(*IssueCreationOptions) (*jira.Issue, error)

	 type ProjectController (interface)

		Methods (only one, which is exported)
			( T) SearchProjects(...string) ([]jira.Project, error)
		Implemented By (at least 2, in which 1 are exported)
			 Controller (interface)
			/* at least one unexported ... *//* at least one unexported: */
			*jiraController

	 type UserController (interface)

		Methods (only one, which is exported)
			( T) GetUser(string) (*jira.User, error)
		Implemented By (at least 2, in which 1 are exported)
			 Controller (interface)
			/* at least one unexported ... *//* at least one unexported: */
			*jiraController

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type jiraController (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			client *jira.Client
			ctx context.Context
			username string
		Methods (total 13, in which 12 are exported)
			(*T) AddCommentToIssue(issueID interface{}, comment string) (*jira.Comment, error)
			(*T) CloneIssue(issueID interface{}) (*jira.Issue, error)
			(*T) CreateIssue(opts *IssueCreationOptions) (*jira.Issue, error)
			(*T) DeleteIssue(issueID interface{}) error
			(*T) GetBoard(boardID string) (*jira.Board, error)
			(*T) GetBoardIssues(boardID string) ([]jira.Issue, error)
			(*T) GetIssue(identifier string, options *jira.GetQueryOptions) (*jira.Issue, error)
			(*T) GetUser(username string) (*jira.User, error)
			(*T) SearchIssues(jql string, options *jira.SearchOptions, maxOccurrences int) ([]jira.Issue, error)
			(*T) SearchProjects(pKeys ...string) ([]jira.Project, error)
			(*T) UpdateIssue(issueID interface{}, data map[string]interface{}) (*jira.Issue, error)
			(*T) UploadAttachmentsToIssue(issueID interface{}, attachments ...*IssueAttachment) error
			/* one unexported ... *//* one unexported: */
			(*T) getIssueFromIdentifier(issueID interface{}) (*jira.Issue, error)
		Implements (at least 5, all are exported)
			*T : BoardController
			*T : Controller
			*T : IssueController
			*T : ProjectController
			*T : UserController
		As Outputs Of (at least one exported)
			func NewJira(ctx context.Context, username, password, url string, skipVerifyTLS bool) (*jiraController, error)

	 type setEntry (struct)

		Fields (only one, which is exported)
			Set string

	 type uploadPayload (struct)

		Fields (only one, which is exported)
			Upload struct{Data map[string]interface{}}


Package-Level Functions (total 2, in which 1 are exported)

	 func NewJira(ctx context.Context, username, password, url string, skipVerifyTLS bool) (*jiraController, error)
	/* one unexported ... *//* one unexported: */
	 func mapToPayload(data map[string]interface{}) (out map[string]interface{})
Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const apiUserRoute = "/rest/api/2/user/search?username=%s"

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.