backlog-js 0.12.6 → 0.13.0

package/dist/types/entity.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { PassThrough } from 'stream';
+import * as Types from "./types";
 export declare namespace File {
     type FileData = NodeFileData | BrowserFileData;
     interface NodeFileData {
@@ -12,6 +13,23 @@ export declare namespace File {
         url: string;
         blob?: () => Promise<Blob>;
     }
+    interface FileInfo {
+        id: number;
+        name: string;
+        size: number;
+    }
+    interface IssueFileInfo extends FileInfo {
+        createdUser: User.User;
+        created: string;
+    }
+    interface WikiFileInfo extends FileInfo {
+        createdUser: User.User;
+        created: string;
+    }
+    interface PullRequestFileInfo extends FileInfo {
+        createdUser: User.User;
+        created: string;
+    }
 }
 export declare namespace OAuth2 {
     interface AccessToken {
@@ -21,3 +39,480 @@ export declare namespace OAuth2 {
         refresh_token: string;
     }
 }
+export declare namespace Space {
+    interface Space {
+        spaceKey: string;
+        name: string;
+        ownerId: number;
+        lang: string;
+        timezone: string;
+        reportSendTime: string;
+        textFormattingRule: Types.TextFormattingRule;
+        created: string;
+        updated: string;
+    }
+    interface Notification {
+        content: string;
+        updated: string;
+    }
+}
+export declare namespace Project {
+    interface Project {
+        id: number;
+        projectKey: string;
+        name: string;
+        chartEnabled: boolean;
+        useResolvedForChart: boolean;
+        subtaskingEnabled: boolean;
+        projectLeaderCanEditProjectLeader: boolean;
+        useWiki: boolean;
+        useFileSharing: boolean;
+        useWikiTreeView: boolean;
+        useOriginalImageSizeAtWiki: boolean;
+        useSubversion: boolean;
+        useGit: boolean;
+        textFormattingRule: Types.TextFormattingRule;
+        archived: boolean;
+        displayOrder: number;
+        useDevAttributes: boolean;
+    }
+    interface RecentlyViewedProject {
+        project: Project;
+        updated: string;
+    }
+    /**
+     * @deprecated
+     */
+    interface Status {
+        id: number;
+        name: string;
+    }
+    interface ProjectStatus {
+        id: number;
+        projectId: number;
+        name: string;
+        color: Types.ProjectStatusColor;
+        displayOrder: number;
+    }
+    interface Category {
+        id: number;
+        projectId: number;
+        name: string;
+        displayOrder: number;
+    }
+    interface Version {
+        id: number;
+        projectId: number;
+        name: string;
+        description?: string;
+        startDate?: string;
+        releaseDueDate?: string;
+        archived: boolean;
+        displayOrder: number;
+    }
+    interface CustomField {
+        id: number;
+        projectId: number;
+        typeId: Types.CustomFieldType;
+        name: string;
+        description: string;
+        required: boolean;
+        applicableIssueTypes: number[];
+        [key: string]: any;
+    }
+    interface SharedFile {
+        id: number;
+        projectId: number;
+        type: string;
+        dir: string;
+        name: string;
+        size: number;
+        createdUser: User.User;
+        created: string;
+        updatedUser: User.User;
+        updated: string;
+    }
+}
+export declare namespace User {
+    interface User {
+        id: number;
+        userId: string;
+        name: string;
+        roleType: Types.RoleType;
+        lang: Types.Language;
+        mailAddress: string;
+        lastLoginTime: string;
+    }
+}
+export declare namespace Activity {
+    interface Activity {
+        id: number;
+        project: Project.Project;
+        type: Types.ActivityType;
+        content: any;
+        notifications: [];
+        createdUser: User.User;
+        created: string;
+    }
+}
+export declare namespace DiskUsage {
+    interface DiskUsage {
+        issue: number;
+        wiki: number;
+        file: number;
+        subversion: number;
+        git: number;
+        gitLFS: number;
+    }
+    interface ProjectDiskUsage extends DiskUsage {
+        projectId: number;
+    }
+    interface SpaceDiskUsage extends DiskUsage {
+        capacity: number;
+        details: ProjectDiskUsage[];
+    }
+}
+export declare namespace CommentNotification {
+    interface CommentNotification {
+        id: number;
+        alreadyRead: boolean;
+        reason: number;
+        user: User.User;
+        resourceAlreadyRead: boolean;
+    }
+}
+export declare namespace Issue {
+    interface IssueType {
+        id: number;
+        projectId: number;
+        name: string;
+        color: Types.IssueTypeColor;
+        displayOrder: number;
+        templateSummary?: string;
+        templateDescription?: string;
+    }
+    interface Priority {
+        id: number;
+        name: string;
+    }
+    interface Resolution {
+        id: number;
+        name: string;
+    }
+    interface Issue {
+        id: number;
+        projectId: number;
+        issueKey: string;
+        keyId: 1;
+        issueType: IssueType;
+        summary: string;
+        description: string;
+        resolution: Resolution;
+        priority: Priority;
+        status: Project.ProjectStatus;
+        assignee: User.User;
+        category: Project.Category[];
+        versions: Project.Version[];
+        milestone: Project.Version[];
+        startDate?: string;
+        dueDate?: string;
+        estimatedHours?: number;
+        actualHours?: number;
+        parentIssueId?: number;
+        createdUser: User.User;
+        created: string;
+        updatedUser: User.User;
+        updated: string;
+        customFields: Project.CustomField[];
+        attachments: File.IssueFileInfo[];
+        sharedFiles: Project.SharedFile[];
+        stars: Star.Star[];
+    }
+    interface RecentlyViewedIssue {
+        issue: Issue;
+        updated: string;
+    }
+    interface IssueCount {
+        count: number;
+    }
+    interface IssueCommentCount {
+        count: number;
+    }
+    interface Comment {
+        id: number;
+        projectId: number;
+        issueId: number;
+        content: string;
+        changeLog: ChangeLog.IssueChangeLog[];
+        createdUser: User.User;
+        created: string;
+        updated: string;
+        stars: Star.Star[];
+        notifications: CommentNotification.CommentNotification[];
+    }
+}
+export declare namespace Star {
+    interface Star {
+        id: number;
+        comment?: string;
+        url: string;
+        title: string;
+        presenter: User.User;
+        created: string;
+    }
+    interface StarCount {
+        count: number;
+    }
+}
+export declare namespace Wiki {
+    interface Tag {
+        id: number;
+        name: string;
+    }
+    interface History {
+        pageId: number;
+        version: number;
+        name: string;
+        content: string;
+        createdUser: User.User;
+        created: string;
+    }
+    interface WikiListItem {
+        id: number;
+        projectId: number;
+        name: string;
+        tags: Tag[];
+        createdUser: User.User;
+        created: string;
+        updatedUser: User.User;
+        updated: string;
+    }
+    interface Wiki {
+        id: number;
+        projectId: number;
+        name: string;
+        content: string;
+        tags: Tag[];
+        attachments: File.WikiFileInfo[];
+        sharedFiles: Project.SharedFile[];
+        stars: Star.Star[];
+        createdUser: User.User;
+        created: string;
+        updatedUser: User.User;
+        updated: string;
+    }
+    interface RecentlyViewedWiki {
+        page: WikiListItem;
+        updated: string;
+    }
+    interface WikiCount {
+        count: number;
+    }
+}
+export declare namespace PullRequest {
+    interface Status {
+        id: number;
+        name: string;
+    }
+    interface PullRequest {
+        id: number;
+        projectId: number;
+        repositoryId: number;
+        number: number;
+        summary: string;
+        description: string;
+        base: string;
+        branch: string;
+        status: Status;
+        assignee: User.User;
+        issue: Issue.Issue;
+        baseCommit?: string;
+        branchCommit?: string;
+        mergeCommit?: string;
+        closeAt?: string;
+        mergeAt?: string;
+        createdUser: User.User;
+        created: string;
+        updatedUser: User.User;
+        updated: string;
+        attachments: File.PullRequestFileInfo[];
+        stars: Star.Star[];
+    }
+    interface Comment {
+        id: number;
+        content: string;
+        changeLog: ChangeLog.PullRequestChangeLog[];
+        createdUser: User.User;
+        created: string;
+        updated: string;
+        stars: Star.Star[];
+        notifications: CommentNotification.CommentNotification[];
+    }
+    interface PullRequestCount {
+        count: number;
+    }
+    interface PullRequestCommentCount {
+        count: number;
+    }
+}
+export declare namespace ChangeLog {
+    interface ChangeLog {
+        field: string;
+        newValue: string;
+        originalValue: string;
+    }
+    interface AttachmentInfo {
+        id: number;
+        type: string;
+    }
+    interface AttributeInfo {
+        id: number;
+        typeId: number;
+    }
+    interface NotificationInfo {
+        type: string;
+    }
+    interface IssueChangeLog extends ChangeLog {
+        attachmentInfo: AttachmentInfo;
+        attributeInfo: AttributeInfo;
+        notificationInfo: NotificationInfo;
+    }
+    type PullRequestChangeLog = ChangeLog;
+}
+export declare namespace Git {
+    interface GitRepository {
+        id: number;
+        projectId: number;
+        name: string;
+        description: string;
+        hookUrl?: string;
+        httpUrl: string;
+        sshUrl: string;
+        displayOrder: number;
+        pushedAt?: string;
+        createdUser: User.User;
+        created: string;
+        updatedUser: User.User;
+        updated: string;
+    }
+}
+export declare namespace WatchingList {
+    interface WatchingListItem {
+        id: number;
+        resourceAlreadyRead: boolean;
+        note: string;
+        type: string;
+        issue: Issue.Issue;
+        lastContentUpdated: string;
+        created: string;
+        updated: string;
+    }
+    interface WatchingListCount {
+        count: number;
+    }
+}
+/**
+ * @deprecated
+ */
+export declare namespace Group {
+    /**
+     * @deprecated
+     */
+    type Group = Team.Team;
+}
+export declare namespace Team {
+    interface Team {
+        id: number;
+        name: string;
+        members: User.User[];
+        displayOrder?: number;
+        createdUser: User.User;
+        created: string;
+        updatedUser: User.User;
+        updated: string;
+    }
+}
+export declare namespace Notification {
+    interface Notification {
+        id: number;
+        alreadyRead: boolean;
+        reason: number;
+        resourceAlreadyRead: boolean;
+        project: Project.Project;
+        issue?: Issue.Issue;
+        comment?: Issue.Comment;
+        pullRequest?: PullRequest.PullRequest;
+        pullRequestComment?: PullRequest.Comment;
+        sender: User.User;
+        created: string;
+    }
+    interface NotificationCount {
+        count: number;
+    }
+}
+export declare namespace Webhook {
+    interface Webhook {
+        id: number;
+        name: string;
+        description: string;
+        hookUrl: string;
+        allEvent: boolean;
+        activityTypeIds: Types.WebhookActivityId[];
+        createdUser: User.User;
+        created: string;
+        updatedUser: User.User;
+        updated: string;
+    }
+}
+export declare namespace License {
+    interface License {
+        active: boolean;
+        attachmentLimit: number;
+        attachmentLimitPerFile: number;
+        attachmentNumLimit: number;
+        attribute: boolean;
+        attributeLimit: number;
+        burndown: boolean;
+        commentLimit: number;
+        componentLimit: number;
+        fileSharing: boolean;
+        gantt: boolean;
+        git: boolean;
+        issueLimit: number;
+        licenceTypeId: number;
+        limitDate: string;
+        nulabAccount: boolean;
+        parentChildIssue: boolean;
+        postIssueByMail: boolean;
+        projectLimit: number;
+        pullRequestAttachmentLimitPerFile: number;
+        pullRequestAttachmentNumLimit: number;
+        remoteAddress: boolean;
+        remoteAddressLimit: number;
+        startedOn: string;
+        storageLimit: number;
+        subversion: boolean;
+        subversionExternal: boolean;
+        userLimit: number;
+        versionLimit: number;
+        wikiAttachment: boolean;
+        wikiAttachmentLimitPerFile: number;
+        wikiAttachmentNumLimit: number;
+    }
+}
+export declare namespace RateLimit {
+    interface RateLimit {
+        rateLimit: ApiRateLimits;
+    }
+    interface ApiRateLimits {
+        read: ApiRateLimit;
+        update: ApiRateLimit;
+        search: ApiRateLimit;
+        icon: ApiRateLimit;
+    }
+    interface ApiRateLimit {
+        limit: number;
+        remaining: number;
+        reset: number;
+    }
+}

package/dist/types/index.d.ts

@@ -2,5 +2,6 @@ import Backlog from './backlog';
 import OAuth2 from './oauth2';
 import * as Option from './option';
 import * as Entity from './entity';
+import * as Types from './types';
 import * as Error from './error';
-export { Backlog, OAuth2, Option, Entity, Error };
+export { Backlog, OAuth2, Option, Entity, Types, Error };

package/dist/types/option.d.ts

@@ -1,28 +1,5 @@
+import * as Types from "./types";
 export declare type Order = "asc" | "desc";
-export declare enum ActivityType {
-    Undefined = -1,
-    IssueCreated = 1,
-    IssueUpdated = 2,
-    IssueCommented = 3,
-    IssueDeleted = 4,
-    WikiCreated = 5,
-    WikiUpdated = 6,
-    WikiDeleted = 7,
-    FileAdded = 8,
-    FileUpdated = 9,
-    FileDeleted = 10,
-    SvnCommitted = 11,
-    GitPushed = 12,
-    GitRepositoryCreated = 13,
-    IssueMultiUpdated = 14,
-    ProjectUserAdded = 15,
-    ProjectUserRemoved = 16,
-    NotifyAdded = 17,
-    PullRequestAdded = 18,
-    PullRequestUpdated = 19,
-    PullRequestCommented = 20,
-    PullRequestMerged = 21
-}
 export declare namespace Notification {
     interface GetNotificationsParams {
         minId?: number;
@@ -37,7 +14,7 @@ export declare namespace Notification {
 }
 export declare namespace Space {
     interface GetActivitiesParams {
-        activityTypeId?: ActivityType[];
+        activityTypeId?: Types.ActivityType[];
         minId?: number;
         maxId?: number;
         count?: number;
@@ -53,24 +30,16 @@ export declare namespace User {
         password: string;
         name: string;
         mailAddress: string;
-        roleType: RoleType;
+        roleType: Types.RoleType;
     }
     interface PatchUserParams {
         password?: string;
         name?: string;
         mailAddress?: string;
-        roleType?: RoleType;
-    }
-    enum RoleType {
-        Admin = 1,
-        User = 2,
-        Reporter = 3,
-        Viewer = 4,
-        GuestReporter = 5,
-        GuestViewer = 6
+        roleType?: Types.RoleType;
     }
     interface GetUserActivitiesParams {
-        activityTypeId?: ActivityType[];
+        activityTypeId?: Types.ActivityType[];
         minId?: number;
         maxId?: number;
         count?: number;
@@ -119,14 +88,13 @@ export declare namespace Team {
     }
 }
 export declare namespace Project {
-    type TextFormattingRule = "backlog" | "markdown";
     interface PostProjectParams {
         name: string;
         key: string;
         chartEnabled: boolean;
         projectLeaderCanEditProjectLeader?: boolean;
         subtaskingEnabled: boolean;
-        textFormattingRule: TextFormattingRule;
+        textFormattingRule: Types.TextFormattingRule;
     }
     interface PatchProjectParams {
         name?: string;
@@ -134,7 +102,7 @@ export declare namespace Project {
         chartEnabled?: boolean;
         subtaskingEnabled?: boolean;
         projectLeaderCanEditProjectLeader?: boolean;
-        textFormattingRule?: TextFormattingRule;
+        textFormattingRule?: Types.TextFormattingRule;
         archived?: boolean;
     }
     interface GetProjectsParams {
@@ -150,14 +118,13 @@ export declare namespace Project {
     interface DeleteProjectAdministrators {
         userId: number;
     }
-    type IssueTypeColor = "#e30000" | "#990000" | "#934981" | "#814fbc" | "#2779ca" | "#007e9a" | "#7ea800" | "#ff9200" | "#ff3265" | "#666665";
     interface PostIssueTypeParams {
         name: string;
-        color: IssueTypeColor;
+        color: Types.IssueTypeColor;
     }
     interface PatchIssueTypeParams {
         name?: string;
-        color?: IssueTypeColor;
+        color?: Types.IssueTypeColor;
     }
     interface DeleteIssueTypeParams {
         substituteIssueTypeId: number;
@@ -170,9 +137,9 @@ export declare namespace Project {
     }
     interface PostVersionsParams {
         name: string;
-        description: string;
-        startDate: string;
-        releaseDueDate: string;
+        description?: string;
+        startDate?: string;
+        releaseDueDate?: string;
     }
     interface PatchVersionsParams {
         name: string;
@@ -182,7 +149,7 @@ export declare namespace Project {
         archived?: boolean;
     }
     interface PostCustomFieldParams {
-        typeId: FieldType;
+        typeId: Types.CustomFieldType;
         name: string;
         applicableIssueTypes?: number[];
         description?: string;
@@ -246,7 +213,7 @@ export declare namespace Project {
         description?: string;
         hookUrl?: string;
         allEvent?: boolean;
-        activityTypeIds?: number[];
+        activityTypeIds?: Types.WebhookActivityId[];
     }
     interface PatchWebhookParams {
         name?: string;
@@ -255,16 +222,6 @@ export declare namespace Project {
         allEvent?: boolean;
         activityTypeIds?: number[];
     }
-    enum FieldType {
-        Text = 1,
-        TextArea = 2,
-        Numeric = 3,
-        Date = 4,
-        SingleList = 5,
-        MultipleList = 6,
-        CheckBox = 7,
-        Radio = 8
-    }
     interface PostStarParams {
         issueId?: number;
         commentId?: number;
@@ -272,14 +229,13 @@ export declare namespace Project {
         pullRequestId?: number;
         pullRequestCommentId?: number;
     }
-    type ProjectStatusColor = "#ea2c00" | "#e87758" | "#e07b9a" | "#868cb7" | "#3b9dbd" | "#4caf93" | "#b0be3c" | "#eda62a" | "#f42858" | "#393939";
     interface PostStatusParams {
         name: string;
-        color: ProjectStatusColor;
+        color: Types.ProjectStatusColor;
     }
     interface PatchStatusParams {
         name?: string;
-        color?: ProjectStatusColor;
+        color?: Types.ProjectStatusColor;
     }
 }
 export declare namespace Issue {