@resolution/jira-api-client 0.1.6 → 0.3.0

package/lib/openapi/software/models/developmentInformation.d.ts

@@ -0,0 +1,649 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+import { type ProviderMetadata } from "./common";
+/**
+ * Author
+ *
+ * Describes the author of a particular entity
+ */
+export interface Author extends Record<string, unknown> {
+    /**
+     * Deprecated. The name of this user in a format suitable for display. Max length
+     * is 255 characters.
+     *
+     * @example Jane Doe
+     * @deprecated
+     */
+    name?: string;
+    /**
+     * The email address of the user. Used to associate the user with a Jira user. Max
+     * length is 255 characters.
+     *
+     * @example jane_doe@atlassian.com
+     */
+    email?: string;
+    /**
+     * Deprecated. The username of the user. Used to associate the user with a Jira
+     * user if there are multiple users for a given email. Max length is 255
+     * characters.
+     *
+     * @example jdoe
+     * @deprecated
+     */
+    username?: string;
+    /**
+     * Deprecated. The URL of the profile for this user. Max length is 2000 characters.
+     *
+     * @example https://atlassian.com/account/jane_doe
+     * @deprecated
+     */
+    url?: string;
+    /**
+     * Deprecated. The URL of the avatar for this user. Max length is 2000 characters.
+     *
+     * @example https://atlassian.com/account/jane_doe/avatar/32
+     * @deprecated
+     */
+    avatar?: string;
+}
+/**
+ * Branch
+ *
+ * Represents a branch in the version control system
+ */
+export interface Branch extends Record<string, unknown> {
+    /**
+     * The ID of this entity. Will be used for cross entity linking. Must be unique by
+     * entity type within a repository, i.e., only one commit can have ID 'X' in
+     * repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is
+     * acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length
+     * is 1024 characters.
+     *
+     * @example c6c7c750-cee2-48e2-b920-d7706dfd11f9
+     */
+    id: string;
+    /**
+     * List of issues keys that this entity is associated with. They must be valid
+     * Jira issue keys.
+     *
+     * @example [
+     *   "ISSUE-1",
+     *   "TEST-2"
+     * ]
+     */
+    issueKeys: string[];
+    /**
+     * An ID used to apply an ordering to updates for this entity in the case of
+     * out-of-order receipt of update requests. This can be any monotonically
+     * increasing number. A suggested implementation is to use epoch millis from the
+     * provider system, but other alternatives are valid (e.g. a provider could store
+     * a counter against each entity and increment that on each update to Jira).
+     * Updates for an entity that are received with an updateSqeuenceId lower than
+     * what is currently stored will be ignored.
+     *
+     * @example 1523494301248
+     */
+    updateSequenceId: number;
+    /**
+     * The name of the branch. Max length is 512 characters.
+     *
+     * @example master
+     */
+    name: string;
+    /**
+     * Commit
+     *
+     * Represents a commit in the version control system.
+     */
+    lastCommit: Commit;
+    /**
+     * The URL of the page for creating a pull request from this branch. Max length is
+     * 2000 characters.
+     *
+     * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/new
+     */
+    createPullRequestUrl?: string;
+    /**
+     * The URL of the branch. Max length is 2000 characters.
+     *
+     * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/master
+     */
+    url: string;
+}
+/**
+ * Commit
+ *
+ * Represents a commit in the version control system.
+ */
+export interface Commit extends Record<string, unknown> {
+    /**
+     * The identifier or hash of the commit. Will be used for cross entity linking.
+     * Must be unique for all commits within a repository, i.e., only one commit can
+     * have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to
+     * repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are
+     * allowed. Max length is 1024 characters
+     *
+     * @example a7727ee6350c33cdf90826dc21abaa26a5704370
+     */
+    id: string;
+    /**
+     * List of issues keys that this entity is associated with. They must be valid
+     * Jira issue keys.
+     *
+     * @example [
+     *   "ISSUE-1",
+     *   "TEST-2"
+     * ]
+     */
+    issueKeys: string[];
+    /**
+     * An ID used to apply an ordering to updates for this entity in the case of
+     * out-of-order receipt of update requests. This can be any monotonically
+     * increasing number. A suggested implementation is to use epoch millis from the
+     * provider system, but other alternatives are valid (e.g. a provider could store
+     * a counter against each entity and increment that on each update to Jira).
+     * Updates for an entity that are received with an updateSqeuenceId lower than
+     * what is currently stored will be ignored.
+     *
+     * @example 1523494301248
+     */
+    updateSequenceId: number;
+    /**
+     * Deprecated. Use the id field instead.
+     *
+     * @deprecated
+     */
+    hash?: string;
+    /**
+     * The set of flags for this commit
+     *
+     * @example [MERGE_COMMIT]
+     */
+    flags?: "MERGE_COMMIT"[];
+    /**
+     * The commit message. Max length is 1024 characters. If anything longer is
+     * supplied, it will be truncated down to 1024 characters.
+     *
+     * @example README.md edited online with Bitbucket
+     */
+    message: string;
+    /**
+     * Author
+     *
+     * Describes the author of a particular entity
+     */
+    author: Author;
+    /**
+     * The total number of files added, removed, or modified by this commit
+     *
+     * @example 1
+     */
+    fileCount: number;
+    /**
+     * The URL of this commit. Max length is 2000 characters.
+     *
+     * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370
+     */
+    url: string;
+    /**
+     * List of file changes. Max number of files is 10. Currently, only the first 5
+     * files are shown (sorted by path) in the UI. This UI behavior may change without
+     * notice.
+     */
+    files?: File[];
+    /**
+     * The author timestamp of this commit. Formatted as a UTC ISO 8601 date time
+     * format.
+     *
+     * @example 2016-10-31T23:27:25+00:00
+     */
+    authorTimestamp: string;
+    /**
+     * Shortened identifier for this commit, used for display. Max length is 255
+     * characters.
+     *
+     * @example a7727ee
+     */
+    displayId: string;
+}
+/**
+ * DevInformation
+ *
+ * Request object for development information push operations, entities are
+ * grouped by repository
+ */
+export interface DevInformation extends Record<string, unknown> {
+    /**
+     * List of repositories containing development information. Must not contain
+     * duplicates. Maximum number of entities across all repositories is 1000.
+     */
+    repositories: Repository[];
+    /**
+     * Flag to prevent automatic issue transitions and smart commits being fired,
+     * default is false.
+     */
+    preventTransitions?: boolean;
+    /**
+     * Indicates the operation being performed by the provider system when sending
+     * this data. "NORMAL" - Data received during normal operation (e.g. a user
+     * pushing a branch). "BACKFILL" - Data received while backfilling existing data
+     * (e.g. indexing a newly connected account). Default is "NORMAL". Please note
+     * that "BACKFILL" operations have a much higher rate-limiting threshold but are
+     * also processed slower in comparison to "NORMAL" operations.
+     *
+     * @example NORMAL
+     */
+    operationType?: "NORMAL" | "BACKFILL";
+    /**
+     * Arbitrary properties to tag the submitted repositories with. These properties
+     * can be used for delete operations to e.g. clean up all development information
+     * associated with an account in the event that the account is removed from the
+     * provider system. Note that these properties will never be returned with
+     * repository or entity data. They are not intended for use as metadata to
+     * associate with a repository. Maximum length of each key or value is 255
+     * characters. Maximum allowed number of properties key/value pairs is 5.
+     * Properties keys cannot start with '_' character. Properties keys cannot contain
+     * ':' character.
+     */
+    properties?: {
+        [key: string]: string;
+    };
+    /**
+     * ProviderMetadata
+     *
+     * Information about the provider. This is useful for auditing, logging,
+     * debugging, and other internal uses. It is not considered private information.
+     * Hence, it may not contain personally identifiable information.
+     */
+    providerMetadata?: ProviderMetadata;
+}
+/**
+ * EntityError
+ *
+ * Represents an error that happened with particular entity.
+ */
+export interface EntityError extends Record<string, unknown> {
+    /** Entity id */
+    id: string;
+    /** Error message */
+    errorMessages?: ({
+        /** A human-readable message describing the error. */
+        message: string;
+        /**
+         * An optional trace ID that can be used by Jira developers to locate the source
+         * of the error.
+         */
+        errorTraceId?: string;
+    } & {
+        [key: string]: unknown;
+    })[];
+}
+/**
+ * EntityIds
+ *
+ * IDs of entities grouped by entity type
+ */
+export interface EntityIds extends Record<string, unknown> {
+    /** Commits IDs */
+    commits?: string[];
+    /** Branch IDs */
+    branches?: string[];
+    /** Pull request IDs */
+    pullRequests?: string[];
+}
+/**
+ * ExistsForPropertiesResponse
+ *
+ * Whether there is data for the properties supplied in a query
+ */
+export interface ExistsForPropertiesResponse extends Record<string, unknown> {
+    /** Whether there is data matching the query */
+    hasDataMatchingProperties?: boolean;
+}
+/**
+ * File
+ *
+ * Describes changes to a file
+ */
+export interface File extends Record<string, unknown> {
+    /**
+     * The path of the file. Max length is 1024 characters.
+     *
+     * @example /home/user/src/atlassian-connect-jira-example/README.md
+     */
+    path: string;
+    /**
+     * The URL of this file. Max length is 2000 characters.
+     *
+     * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md
+     */
+    url: string;
+    /**
+     * The operation performed on this file
+     *
+     * @example MODIFIED
+     */
+    changeType: "ADDED" | "COPIED" | "DELETED" | "MODIFIED" | "MOVED" | "UNKNOWN";
+    /**
+     * Number of lines added to the file
+     *
+     * @example 0
+     */
+    linesAdded: number;
+    /**
+     * Number of lines removed from the file
+     *
+     * @example 1
+     */
+    linesRemoved: number;
+}
+/**
+ * PullRequest
+ *
+ * Represents a pull request
+ */
+export interface PullRequest extends Record<string, unknown> {
+    /**
+     * The ID of this entity. Will be used for cross entity linking. Must be unique by
+     * entity type within a repository, i.e., only one commit can have ID 'X' in
+     * repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is
+     * acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length
+     * is 1024 characters
+     *
+     * @example c6c7c750-cee2-48e2-b920-d7706dfd11f9
+     */
+    id: string;
+    /**
+     * List of issues keys that this entity is associated with. They must be valid
+     * Jira issue keys.
+     *
+     * @example [
+     *   "ISSUE-1",
+     *   "TEST-2"
+     * ]
+     */
+    issueKeys: string[];
+    /**
+     * An ID used to apply an ordering to updates for this entity in the case of
+     * out-of-order receipt of update requests. This can be any monotonically
+     * increasing number. A suggested implementation is to use epoch millis from the
+     * provider system, but other alternatives are valid (e.g. a provider could store
+     * a counter against each entity and increment that on each update to Jira).
+     * Updates for an entity that are received with an updateSqeuenceId lower than
+     * what is currently stored will be ignored.
+     *
+     * @example 1523494301248
+     */
+    updateSequenceId: number;
+    /**
+     * The status of the pull request. In the case of concurrent updates, priority is
+     * given in the order OPEN, MERGED, DECLINED, UNKNOWN
+     *
+     * @example OPEN
+     */
+    status: "OPEN" | "MERGED" | "DECLINED" | "UNKNOWN";
+    /**
+     * Title of the pull request. Max length is 1024 characters.
+     *
+     * @example Pull request 2, fixing all the issues caused by pull request #1
+     */
+    title: string;
+    /**
+     * Author
+     *
+     * Describes the author of a particular entity
+     */
+    author: Author;
+    /**
+     * The number of comments on the pull request
+     *
+     * @example 42
+     */
+    commentCount: number;
+    /**
+     * The name of the source branch of this PR. Max length is 255 characters.
+     *
+     * @example ISSUE-1-feature-branch
+     */
+    sourceBranch: string;
+    /**
+     * The url of the source branch of this PR. This is used to match this PR against
+     * the branch. Max length is 2000 characters.
+     *
+     * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/ISSUE-1-feature-branch
+     */
+    sourceBranchUrl?: string;
+    /**
+     * The most recent update to this PR. Formatted as a UTC ISO 8601 date time format.
+     *
+     * @example 2016-10-31T23:27:25+00:00
+     */
+    lastUpdate: string;
+    /**
+     * The name of destination branch of this PR. Max length is 255 characters.
+     *
+     * @example master
+     */
+    destinationBranch?: string;
+    /**
+     * The url of the destination branch of this PR. Max length is 2000 characters.
+     *
+     * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/master
+     */
+    destinationBranchUrl?: string;
+    /** The list of reviewers of this pull request */
+    reviewers?: Reviewer[];
+    /**
+     * The URL of this pull request. Max length is 2000 characters.
+     *
+     * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/2
+     */
+    url: string;
+    /**
+     * Shortened identifier for this pull request, used for display. Max length is 255
+     * characters.
+     *
+     * @example Pull request 2
+     */
+    displayId: string;
+}
+/**
+ * Repository
+ *
+ * Represents a repository, containing development information such as commits,
+ * pull requests, and branches.
+ */
+export interface Repository extends Record<string, unknown> {
+    /**
+     * The name of this repository. Max length is 255 characters.
+     *
+     * @example atlassian-connect-jira-example
+     */
+    name: string;
+    /**
+     * Description of this repository. Max length is 1024 characters.
+     *
+     * @example The repository which stores code of the Atlassian Connect Add-on Devinfo
+     * application.
+     */
+    description?: string;
+    /**
+     * The ID of the repository this repository was forked from, if it's a fork. Max
+     * length is 1024 characters.
+     *
+     * @example 56c7c750-cee2-48e2-b920-d7706dfd11f7
+     */
+    forkOf?: string;
+    /**
+     * The URL of this repository. Max length is 2000 characters.
+     *
+     * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example
+     */
+    url: string;
+    /**
+     * List of commits to update in this repository. Must not contain duplicate entity
+     * IDs. Maximum number of commits is 400
+     */
+    commits?: Commit[];
+    /**
+     * List of branches to update in this repository. Must not contain duplicate
+     * entity IDs. Maximum number of branches is 400.
+     */
+    branches?: Branch[];
+    /**
+     * List of pull requests to update in this repository. Must not contain duplicate
+     * entity IDs. Maximum number of pull requests is 400
+     */
+    pullRequests?: PullRequest[];
+    /**
+     * The URL of the avatar for this repository. Max length is 2000 characters.
+     *
+     * @example http://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/avatar/32
+     */
+    avatar?: string;
+    /**
+     * Description of the avatar for this repository. Max length is 1024 characters.
+     *
+     * @example Avatar description
+     */
+    avatarDescription?: string;
+    /**
+     * The ID of this entity. Will be used for cross entity linking. Must be unique by
+     * entity type within a repository, i.e., only one commit can have ID 'X' in
+     * repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is
+     * acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length
+     * is 1024 characters.
+     *
+     * @example c6c7c750-cee2-48e2-b920-d7706dfd11f9
+     */
+    id: string;
+    /**
+     * An ID used to apply an ordering to updates for this entity in the case of
+     * out-of-order receipt of update requests. This can be any monotonically
+     * increasing number. A suggested implementation is to use epoch millis from the
+     * provider system, but other alternatives are valid (e.g. a provider could store
+     * a counter against each entity and increment that on each update to Jira).
+     * Updates for an entity that are received with an updateSqeuenceId lower than
+     * what is currently stored will be ignored.
+     *
+     * @example 1523494301248
+     */
+    updateSequenceId: number;
+}
+/**
+ * RepositoryErrors
+ *
+ * Represents errors related to a particular repository and its entities
+ */
+export interface RepositoryErrors extends Record<string, unknown> {
+    /** Repository errors */
+    errorMessages?: ({
+        /** A human-readable message describing the error. */
+        message: string;
+        /**
+         * An optional trace ID that can be used by Jira developers to locate the source
+         * of the error.
+         */
+        errorTraceId?: string;
+    } & {
+        [key: string]: unknown;
+    })[];
+    /** Commits errors */
+    commits?: EntityError[];
+    /** Branches errors */
+    branches?: EntityError[];
+    /** Pull requests errors */
+    pullRequests?: EntityError[];
+}
+/**
+ * Reviewer
+ *
+ * The reviewer of a pull request
+ */
+export interface Reviewer extends Record<string, unknown> {
+    /**
+     * Deprecated. The name of this reviewer. Max length is 255 characters.
+     *
+     * @example Jane Doe
+     * @deprecated
+     */
+    name?: string;
+    /**
+     * The approval status of this reviewer, default is UNAPPROVED.
+     *
+     * @example APPROVED
+     */
+    approvalStatus?: "APPROVED" | "UNAPPROVED";
+    /**
+     * Deprecated. The URL of the profile for this reviewer. Max length is 2000
+     * characters.
+     *
+     * @example https://atlassian.com/account/jane_doe
+     * @deprecated
+     */
+    url?: string;
+    /**
+     * Deprecated. The URL of the avatar for this reviewer. Max length is 2000
+     * characters.
+     *
+     * @example https://atlassian.com/account/jane_doe/avatar/32
+     * @deprecated
+     */
+    avatar?: string;
+    /**
+     * The email address of this reviewer. Max length is 254 characters.
+     *
+     * @example jane_doe@example.com
+     */
+    email?: string;
+    /**
+     * The Atlassian Account ID (AAID) of this reviewer. Max length is 128 characters.
+     *
+     * @example 655363:e4ca5e2d-a901-40e3-877e-bf5d22c0f130
+     */
+    accountId?: string;
+}
+/**
+ * StoreDevinfoResult
+ *
+ * The result of a successful store development information request
+ */
+export interface StoreDevinfoResult extends Record<string, unknown> {
+    /**
+     * The IDs of devinfo entities that have been accepted for submission grouped by
+     * their repository IDs. Note that a devinfo entity that isn't updated due to it's
+     * updateSequenceId being out of order is not considered a failed submission.
+     */
+    acceptedDevinfoEntities?: {
+        /**
+         * EntityIds
+         *
+         * IDs of entities grouped by entity type
+         */
+        [entityIds: string]: EntityIds;
+    };
+    /**
+     * IDs of devinfo entities that have not been accepted for submission and caused
+     * error descriptions, usually due to a problem with the request data. The
+     * entities (if present) will be grouped by their repository id and type. Entity
+     * IDs are listed with errors associated with that devinfo entity that have
+     * prevented it being submitted.
+     */
+    failedDevinfoEntities?: {
+        /**
+         * RepositoryErrors
+         *
+         * Represents errors related to a particular repository and its entities
+         */
+        [repositoryErrors: string]: RepositoryErrors;
+    };
+    /**
+     * Issue keys that are not known on this Jira instance (if any). These may be
+     * invalid keys (e.g. `UTF-8` is sometimes incorrectly identified as a Jira issue
+     * key), or they may be for projects that no longer exist. If a devinfo entity has
+     * been associated with issue keys other than those in this array it will still be
+     * stored against those valid keys.
+     */
+    unknownIssueKeys?: string[];
+}
+export declare function registerDevelopmentInformationValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;