jira

type Adapter struct {
	JiraClient Client
}

type Client interface {
	GetPage(ctx context.Context, request *Request) (*Response, *framework.Error)
}

type Config struct {
	// Common configuration
	*config.CommonConfig

	// IssuesJQLFilter is the JQL filter to use when querying for issues.
	// e.g. "project=SGNL OR project=MVP".
	// https://support.atlassian.com/jira-software-cloud/docs/what-is-advanced-search-in-jira-cloud/.
	// If the JQL is invalid, Jira will return a 400.
	// An invalid JQL does not necessarily mean a syntax error, but also for example
	// if a project does not exist, e.g. project=INVALID.
	// Therefore, it's up to the client to ensure the JQL is valid.
	IssuesJQLFilter *string `json:"issuesJqlFilter,omitempty"`

	// ObjectsQLQuery is the AQL query to use when querying for custom Objects.
	// e.g. "qlQuery="objectType = Customer".
	// https://developer.atlassian.com/cloud/assets/rest/api-group-object/#api-object-aql-post.
	// It is up to the client to ensure the ObjectsQLQuery is valid.
	// This field is only used for the Object entity.
	ObjectsQLQuery *string `json:"objectsQlQuery,omitempty"`

	// AssetBaseURL is the base URL to use when querying for Objects.
	// e.g. "https://api.atlassian.com/jsm/assets".
	// If not, specified it defaults to "https://api.atlassian.com/jsm/assets".
	// This field is only used for the Object entity.
	AssetBaseURL *string `json:"assetBaseUrl,omitempty"`

	// EnhancedIssueSearch determines whether we should use the legacy JQL search endpoint currently being deprecated:
	// https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-post
	// or if we should use the new "enhanced" JQL search endpoint:
	// https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-jql-post.
	//
	// This will eventually be removed and all requests will default to the new enhanced endpoint. This is being added
	// so we can apply this on a per instance basis during this rolling deprecation.
	EnhancedIssueSearch bool `json:"enhancedIssueSearch,omitempty"`
}

type Datasource struct {
	Client *http.Client
}

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

type Request struct {
	// BaseURL is the base URL of the Jira instance. For example, "https://{domain}.atlassian.net".
	BaseURL string

	// Username is the user name used to authenticate with Jira using basic auth.
	Username string

	// Password is user's Jira API token used to authenticate with Jira using basic auth.
	Password string

	// PageSize is the maximum number of objects to return per page from the API call.
	// This is used as the "maxResults" parameter in the Jira API.
	PageSize int64

	// EntityExternalID is the external ID of the entity. If it's not a valid external ID, then
	// no request will be made.
	EntityExternalID string

	// Cursor identifies the first object of the page to return, as returned by
	// the last request for the entity.
	// nil in the request for the first page.
	Cursor *pagination.CompositeCursor[string]

	// IssuesJQLFilter is a JQL filter to apply to the request.
	// This is only used when EntityExternalID = "Issue".
	IssuesJQLFilter *string

	// ObjectsQLQuery is a AQL query to apply to the request.
	// This is only used when EntityExternalID = "Object".
	ObjectsQLQuery *string

	// AssetBaseURL is the base URL to retrieve Asset Objects.
	// This is only used when EntityExternalID = "Object".
	AssetBaseURL *string

	// RequestTimeoutSeconds is the timeout duration for requests made to datasources.
	// This should be set to the number of seconds to wait before timing out.
	RequestTimeoutSeconds int
}

type Response struct {
	// StatusCode is an HTTP status code.
	StatusCode int

	// RetryAfterHeader is the Retry-After response HTTP header, if set.
	RetryAfterHeader string

	// Objects is the list of parsed entity objects returned from Jira.
	// May be empty.
	Objects []map[string]any

	// NextCursor is the cursor that identifies the first object of the next page.
	// nil if this is the last page in this full sync.
	NextCursor *pagination.CompositeCursor[string]
}