@resolution/jira-api-client 0.14.1 → 0.15.1

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

@@ -1,277 +1,6 @@
 import type { CommonValidationSchemaStorage } from "../../core/CommonValidationSchemaStorage";
-import { type ProviderMetadata } from "./common";
+import { type Repository, type ProviderMetadata, type IssueIdOrKeysAssociation } from "./common";
 import { type ZodTypeAny } from "zod";
-/**
- * Author
- *
- * Describes the author of a particular entity
- *
- * @category Models
- */
-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
-     * ```
-     * JaneDoe
-     * ```
-     * @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
- *
- * @category Models
- */
-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.
- *
- * @category Models
- */
-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.mdedited 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
  *
@@ -377,319 +106,6 @@ export interface ExistsForPropertiesResponse extends Record<string, unknown> {
     /** Whether there is data matching the query */
     hasDataMatchingProperties?: boolean;
 }
-/**
- * File
- *
- * Describes changes to a file
- *
- * @category Models
- */
-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
- *
- * @category Models
- */
-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
-     * ```
-     * Pullrequest 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
-     * ```
-     * Pullrequest 2
-     * ```
-     */
-    displayId: string;
-}
-/**
- * Repository
- *
- * Represents a repository, containing development information such as commits,
- * pull requests, and branches.
- *
- * @category Models
- */
-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
-     * ```
-     * Therepository 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
-     * ```
-     * Avatardescription
-     * ```
-     */
-    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
  *
@@ -717,74 +133,6 @@ export interface RepositoryErrors extends Record<string, unknown> {
     /** Pull requests errors */
     pullRequests?: EntityError[];
 }
-/**
- * Reviewer
- *
- * The reviewer of a pull request
- *
- * @category Models
- */
-export interface Reviewer extends Record<string, unknown> {
-    /**
-     * Deprecated. The name of this reviewer. Max length is 255 characters.
-     *
-     * @example
-     * ```
-     * JaneDoe
-     * ```
-     * @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
  *
@@ -829,5 +177,18 @@ export interface StoreDevinfoResult extends Record<string, unknown> {
      * stored against those valid keys.
      */
     unknownIssueKeys?: string[];
+    /**
+     * Associations 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 development information entity has been associated with any other
+     * association other than those in this array it will still be stored against
+     * those valid associations.
+     * If a development information entity was only associated with the associations
+     * in this array, it is deemed to be invalid and it won't be persisted.
+     */
+    unknownAssociations?: IssueIdOrKeysAssociation[];
 }
 export declare function registerDevelopmentInformationValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;