@valiantys/atlassian-app 3.2.0-alpha-1

package/util-jira-v3-api/atlassian-app.api.md

@@ -0,0 +1,777 @@
+## API Report File for "@valiantys/atlassian-app"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+export interface AtlassianDocumentFormat {
+    // (undocumented)
+    content: AtlassianDocumentFormatNode[];
+    // (undocumented)
+    type: 'doc';
+    // (undocumented)
+    version: number;
+}
+
+// @public (undocumented)
+export interface AtlassianDocumentFormatBlockNode {
+    // (undocumented)
+    content: AtlassianDocumentFormatNode[];
+    // (undocumented)
+    type: string;
+}
+
+// @public (undocumented)
+export interface AtlassianDocumentFormatInlineNode {
+    // (undocumented)
+    type: string;
+}
+
+// @public (undocumented)
+export type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
+
+// @public (undocumented)
+export interface AtlassianDocumentFormatParagraphNode extends AtlassianDocumentFormatBlockNode {
+    // (undocumented)
+    content: AtlassianDocumentFormatInlineNode[];
+    // (undocumented)
+    type: 'paragraph';
+}
+
+// @public (undocumented)
+export interface AtlassianDocumentFormatTextNode extends AtlassianDocumentFormatInlineNode {
+    // (undocumented)
+    text: string;
+    // (undocumented)
+    type: 'text';
+}
+
+// @public (undocumented)
+export interface AvatarUrls {
+    // (undocumented)
+    '16x16': string;
+    // (undocumented)
+    '24x24': string;
+    // (undocumented)
+    '32x32': string;
+    // (undocumented)
+    '48x48': string;
+}
+
+// @public (undocumented)
+export interface CreatedIssue {
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    key: string;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    transition?: {
+        status: number;
+        errorCollection?: {
+            errorMessages: string[];
+            errors: unknown;
+        };
+        warningCollection?: {
+            warnings: string[];
+        };
+    };
+}
+
+// @public (undocumented)
+export interface CreateIssue {
+    // (undocumented)
+    fields: IssueFields<AtlassianDocumentFormat | string>;
+    // (undocumented)
+    historyMetadata?: HistoryMetadata;
+    // (undocumented)
+    properties?: {
+        key: string;
+        value: unknown;
+    }[];
+    // (undocumented)
+    transition?: IssueTransition;
+    // (undocumented)
+    update?: Record<string, Record<string, unknown>[]>;
+}
+
+// @public (undocumented)
+export type CustomFields = Record<string, unknown>;
+
+// @public (undocumented)
+export interface EntityProperty {
+    // (undocumented)
+    key: string;
+    // (undocumented)
+    value: unknown;
+}
+
+// @public (undocumented)
+export const FIX_VERSIONS_FIELD = "fixVersions";
+
+// @public (undocumented)
+export interface FixVersion {
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    released?: boolean;
+    // (undocumented)
+    releaseDate?: string;
+    // (undocumented)
+    self?: string;
+}
+
+// @public (undocumented)
+export type FixVersions = FixVersion[];
+
+// @public (undocumented)
+export interface HealthCheckResult {
+    // (undocumented)
+    description: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    passed: boolean;
+}
+
+// @public (undocumented)
+export interface HistoryMetadata {
+    // (undocumented)
+    activityDescription?: string;
+    // (undocumented)
+    activityDescriptionKey?: string;
+    // (undocumented)
+    actor?: HistoryMetadataParticipant;
+    // (undocumented)
+    cause?: HistoryMetadataParticipant;
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    descriptionKey?: string;
+    // (undocumented)
+    emailDescription?: string;
+    // (undocumented)
+    emailDescriptionKey?: string;
+    // (undocumented)
+    extraData?: unknown;
+    // (undocumented)
+    generator?: HistoryMetadataParticipant;
+    // (undocumented)
+    type?: string;
+}
+
+// @public (undocumented)
+export interface HistoryMetadataParticipant {
+    // (undocumented)
+    avatarUrl: string;
+    // (undocumented)
+    displayName: string;
+    // (undocumented)
+    displayNameKey: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    type: string;
+    // (undocumented)
+    url: string;
+}
+
+// @public (undocumented)
+export function isAtlassianDocumentFormatParagraphNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatParagraphNode;
+
+// @public (undocumented)
+export function isAtlassianDocumentFormatTextNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatTextNode;
+
+// @public (undocumented)
+export interface Issue<T = AtlassianDocumentFormat> {
+    // (undocumented)
+    expand?: string;
+    // (undocumented)
+    fields: IssueFields<T>;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    key: string;
+    // (undocumented)
+    renderedFields?: IssueFields<string>;
+    // (undocumented)
+    self?: string;
+}
+
+// @public (undocumented)
+export type IssueComment = {
+    author: User;
+    body: AtlassianDocumentFormat;
+    created: string;
+    id: string;
+    self: string;
+    updateAuthor: User;
+    updated: string;
+    visibility: Visibility;
+};
+
+// @public (undocumented)
+export type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
+
+// @public (undocumented)
+export interface IssueLink {
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    inwardIssue?: Issue;
+    // (undocumented)
+    outwardIssue?: Issue;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    type: {
+        id: string;
+        name: string;
+        inward: string;
+        outward: string;
+        self: string;
+    };
+}
+
+// @public (undocumented)
+export interface IssueLinkRequest {
+    // (undocumented)
+    comment?: {
+        body: AtlassianDocumentFormat;
+    };
+    // (undocumented)
+    inwardIssue: {
+        id?: string;
+        key?: string;
+    };
+    // (undocumented)
+    outwardIssue: {
+        id?: string;
+        key?: string;
+    };
+    // (undocumented)
+    type: {
+        id?: string;
+        name?: string;
+    };
+}
+
+// @public (undocumented)
+export interface IssueStatus {
+    // (undocumented)
+    description: string;
+    // (undocumented)
+    iconUrl: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    statusCategory: {
+        self: string;
+        id: number;
+        key: string;
+        colorName: string;
+        name: string;
+    };
+    // (undocumented)
+    untranslatedName?: string;
+}
+
+// @public (undocumented)
+export interface IssueTransition {
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    looped?: boolean;
+}
+
+// @public (undocumented)
+export interface IssueTypeDetails {
+    // (undocumented)
+    avatarId: number;
+    // (undocumented)
+    description: string;
+    // (undocumented)
+    hierarchyLevel: number;
+    // (undocumented)
+    iconUrl: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    subtask: boolean;
+}
+
+// @public (undocumented)
+export interface IssueTypeScheme {
+    // (undocumented)
+    defaultIssueTypeId?: string;
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    isDefault: boolean;
+    // (undocumented)
+    name: string;
+}
+
+// @public (undocumented)
+export interface IssueTypeSchemeExpanded extends IssueTypeScheme {
+    // (undocumented)
+    issueTypes?: PagedResponse<IssueTypeDetails>;
+    // (undocumented)
+    projects?: PagedResponse<Project>;
+}
+
+// @public (undocumented)
+export interface IssueTypeSchemeForProjects {
+    // (undocumented)
+    issueTypeScheme: IssueTypeScheme;
+    // (undocumented)
+    projectIds: string[];
+}
+
+// @public (undocumented)
+export type JiraCommentResponse = {
+    comments: IssueComment[];
+    maxResults: number;
+    startAt: number;
+    total: number;
+};
+
+// @public (undocumented)
+export interface JiraServerInfo {
+    // (undocumented)
+    baseUrl: string;
+    // (undocumented)
+    buildDate: string;
+    // (undocumented)
+    buildNumber: number;
+    // (undocumented)
+    deploymentType: string;
+    // (undocumented)
+    displayUrl: string;
+    // (undocumented)
+    displayUrlConfluence: string;
+    // (undocumented)
+    displayUrlServicedeskHelpCenter: string;
+    // (undocumented)
+    healthChecks: HealthCheckResult[];
+    // (undocumented)
+    scmInfo: string;
+    // (undocumented)
+    serverTime: string;
+    // (undocumented)
+    serverTimeZone: string;
+    // (undocumented)
+    serverTitle: string;
+    // (undocumented)
+    version: string;
+    // (undocumented)
+    versionNumbers: number[];
+}
+
+// @public (undocumented)
+export interface PagedResponse<T> {
+    // (undocumented)
+    isLast: boolean;
+    // (undocumented)
+    maxResults: number;
+    // (undocumented)
+    startAt: number;
+    // (undocumented)
+    total: number;
+    // (undocumented)
+    values: T[];
+}
+
+// @public (undocumented)
+export interface PagedResponseWithNextLink<T> extends PagedResponse<T> {
+    // (undocumented)
+    nextPage?: string;
+}
+
+// @public (undocumented)
+export type PagedUsers = PagedResponse<User | null>;
+
+// @public (undocumented)
+export type Precomputation = {
+    id: string;
+    value: string;
+    functionKey: string;
+    functionName: string;
+    field: string;
+    operator: 'not in' | 'in';
+    arguments: string[];
+    created: string;
+    updated: string;
+    used: string;
+};
+
+// @public (undocumented)
+export type PrecomputationPayload = {
+    precomputationId: string;
+    clause: {
+        field: string;
+        type: string[];
+        operator: string;
+        functionName: string;
+        arguments: string[];
+    };
+    context?: {
+        cloudId: string;
+        moduleKey: string;
+    };
+    contextToken?: string;
+};
+
+// @public (undocumented)
+export type PrecomputationResponse = PagedResponse<Precomputation>;
+
+// @public (undocumented)
+export type PrecomputationUpdate = {
+    id: string;
+    value: string;
+} | {
+    id: string;
+    error: string;
+};
+
+// @public (undocumented)
+export interface Project {
+    // (undocumented)
+    archived?: boolean;
+    // (undocumented)
+    avatarUrls?: AvatarUrls;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    key?: string;
+    // (undocumented)
+    lead?: User;
+    // (undocumented)
+    name?: string;
+    // (undocumented)
+    projectTypeKey?: string;
+    // (undocumented)
+    self?: string;
+    // (undocumented)
+    simplified?: boolean;
+}
+
+// @public (undocumented)
+export interface ProjectProperty<T> {
+    // (undocumented)
+    key: string;
+    // (undocumented)
+    value: T;
+}
+
+// @public (undocumented)
+export interface ProjectVersion {
+    // (undocumented)
+    archived: boolean;
+    // (undocumented)
+    description: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    overdue?: boolean;
+    // (undocumented)
+    projectId?: number;
+    // (undocumented)
+    released: boolean;
+    // (undocumented)
+    releaseDate?: number;
+    // (undocumented)
+    releaseDateSet?: boolean;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    startDateSet?: boolean;
+    // (undocumented)
+    userReleaseDate?: string;
+}
+
+// @public (undocumented)
+export interface RemoteIssueLink {
+    // (undocumented)
+    application?: {
+        name?: string;
+        type?: string;
+    };
+    // (undocumented)
+    globalId?: string;
+    // (undocumented)
+    id?: number;
+    // (undocumented)
+    object: {
+        icon?: {
+            title?: string;
+            url16x16?: string;
+        };
+        status?: {
+            icon?: {
+                link?: string;
+                title?: string;
+                url16x16?: string;
+            };
+            resolved?: boolean;
+        };
+        summary?: string;
+        title: string;
+        url: string;
+    };
+    // (undocumented)
+    relationship?: string;
+    // (undocumented)
+    self?: string;
+}
+
+// @public (undocumented)
+export interface StaticIssueFields<T = AtlassianDocumentFormat> {
+    // (undocumented)
+    aggregatetimespent?: number;
+    // (undocumented)
+    assignee?: User;
+    // (undocumented)
+    components?: {
+        id: string;
+        name: string;
+    }[];
+    // (undocumented)
+    created?: string;
+    // (undocumented)
+    creator?: User;
+    // (undocumented)
+    description?: T;
+    // (undocumented)
+    fixVersions?: FixVersions;
+    // (undocumented)
+    issuelinks?: IssueLink[];
+    // (undocumented)
+    issuetype?: {
+        self?: string;
+        id: string;
+        description?: string;
+        iconUrl?: string;
+        name?: string;
+        subtask?: boolean;
+        avatarId?: number;
+        hierarchyLevel?: number;
+    };
+    // (undocumented)
+    labels?: string[];
+    // (undocumented)
+    lastViewed?: string;
+    // (undocumented)
+    priority?: {
+        self: string;
+        iconUrl: string;
+        name: string;
+        id: string;
+    };
+    // (undocumented)
+    project?: Project;
+    // (undocumented)
+    reporter?: User;
+    // (undocumented)
+    resolution?: unknown;
+    // (undocumented)
+    resolutiondate?: string;
+    // (undocumented)
+    status?: IssueStatus;
+    // (undocumented)
+    statuscategorychangedate?: string;
+    // (undocumented)
+    summary?: string;
+    // (undocumented)
+    timeestimate?: number;
+    // (undocumented)
+    timespent?: number;
+    // (undocumented)
+    timetracking?: {
+        remainingEstimate: string;
+        timeSpent: string;
+        remainingEstimateSeconds: number;
+        timeSpentSeconds: number;
+    };
+    // (undocumented)
+    updated?: string;
+    // (undocumented)
+    watches?: {
+        self: string;
+        watchCount: number;
+        isWatching: boolean;
+    };
+    // (undocumented)
+    worklog?: {
+        total: number;
+        startAt: number;
+        maxResults: number;
+        worklogs: Worklog[];
+    };
+    // (undocumented)
+    workratio?: number;
+}
+
+// @public (undocumented)
+export function switchAtlassianApiUrlToUseSiteUrl(siteBaseUrl: string, apiDotAtlassianUrl: string): string;
+
+// @public (undocumented)
+export interface TransitionIssueRequest {
+    // (undocumented)
+    fields?: any;
+    // (undocumented)
+    historyMetadata?: HistoryMetadata;
+    // (undocumented)
+    properties?: EntityProperty[];
+    // (undocumented)
+    transition: IssueTransition;
+    // (undocumented)
+    update?: any;
+}
+
+// @public (undocumented)
+export type UpdateIssue = CreateIssue;
+
+// @public (undocumented)
+export interface User {
+    // (undocumented)
+    accountId: string;
+    // (undocumented)
+    accountType?: string;
+    // (undocumented)
+    active: boolean;
+    // (undocumented)
+    avatarUrls?: AvatarUrls;
+    // (undocumented)
+    displayName: string;
+    // (undocumented)
+    emailAddress?: string;
+    // (undocumented)
+    groups?: {
+        items?: UserGroupName[];
+        size?: number;
+    };
+    // (undocumented)
+    self?: string;
+    // (undocumented)
+    timeZone: string;
+}
+
+// @public (undocumented)
+export interface UserGroupName {
+    // (undocumented)
+    groupId: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    self: string;
+}
+
+// @public (undocumented)
+export interface UserPickerQueryResponse {
+    // (undocumented)
+    header: string;
+    // (undocumented)
+    total: number;
+    // (undocumented)
+    users: UserPickerUser[];
+}
+
+// @public (undocumented)
+export interface UserPickerUser {
+    // (undocumented)
+    accountId: string;
+    // (undocumented)
+    accountType: string;
+    // (undocumented)
+    displayName: string;
+    // (undocumented)
+    html?: string;
+}
+
+// @public (undocumented)
+export type Visibility = {
+    identifier: string;
+    type: string;
+    value: string;
+};
+
+// @public (undocumented)
+export interface Worklog extends WorklogCreateRequest {
+    // (undocumented)
+    author: User;
+    // (undocumented)
+    created: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    issueId: string;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    updateAuthor: User;
+    // (undocumented)
+    updated: string;
+}
+
+// @public
+export interface WorklogComment {
+    // (undocumented)
+    content: [
+        {
+        type: 'paragraph';
+        content: [
+            {
+            type: 'text';
+            text: string;
+        }
+        ];
+    }
+    ];
+    // (undocumented)
+    type: 'doc';
+    // (undocumented)
+    version: 1;
+}
+
+// @public (undocumented)
+export interface WorklogCreateRequest {
+    // (undocumented)
+    comment?: WorklogComment;
+    // (undocumented)
+    properties?: EntityProperty[];
+    // (undocumented)
+    started: string;
+    // (undocumented)
+    timeSpent?: string;
+    // (undocumented)
+    timeSpentSeconds?: number;
+    // (undocumented)
+    visibility?: {
+        identifier: string;
+        type: string;
+        value: string;
+    };
+}
+
+// (No @packageDocumentation comment for this package)
+
+```