@pschroee/redmine-mcp 0.3.1

package/dist/redmine/client.d.ts

@@ -0,0 +1,349 @@
+import type { RedmineIssue, RedmineIssuesResponse, RedmineProject, RedmineProjectsResponse, RedmineResult, RedmineWikiPage, RedmineWikiPagesResponse, RedmineAttachment, RedmineUploadResponse, RedmineFilesResponse, RedmineRelation, RedmineRelationsResponse, RedmineVersion, RedmineVersionsResponse, RedmineTrackersResponse, RedmineIssueStatusesResponse, RedmineCategory, RedmineCategoriesResponse, RedmineCustomFieldsResponse, RedmineQueriesResponse, RedmineSearchResponse, RedmineMyAccountResponse, RedmineTimeEntry, RedmineTimeEntriesResponse, RedmineIssuePrioritiesResponse, RedmineTimeEntryActivitiesResponse, RedmineDocumentCategoriesResponse, RedmineUser, RedmineUsersResponse, RedmineGroup, RedmineGroupsResponse, RedmineMembership, RedmineMembershipsResponse, RedmineRole, RedmineRolesResponse } from "./types.js";
+export declare class RedmineClient {
+    private baseUrl;
+    private apiKey;
+    constructor(baseUrl: string, apiKey: string);
+    private request;
+    listIssues(params?: {
+        project_id?: string | number;
+        subproject_id?: string;
+        tracker_id?: number;
+        status_id?: string | number;
+        assigned_to_id?: number | string;
+        parent_id?: number;
+        author_id?: number | string;
+        category_id?: number;
+        fixed_version_id?: number;
+        subject?: string;
+        created_on?: string;
+        updated_on?: string;
+        sort?: string;
+        include?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<RedmineResult<RedmineIssuesResponse>>;
+    getIssue(id: number, include?: string): Promise<RedmineResult<{
+        issue: RedmineIssue;
+    }>>;
+    createIssue(data: {
+        project_id: number | string;
+        subject: string;
+        description?: string;
+        tracker_id?: number;
+        status_id?: number;
+        priority_id?: number;
+        assigned_to_id?: number;
+        category_id?: number;
+        fixed_version_id?: number;
+        parent_issue_id?: number;
+        custom_fields?: {
+            id: number;
+            value: string | string[];
+        }[];
+        watcher_user_ids?: number[];
+        is_private?: boolean;
+        estimated_hours?: number;
+        start_date?: string;
+        due_date?: string;
+        uploads?: {
+            token: string;
+            filename: string;
+            content_type?: string;
+            description?: string;
+        }[];
+    }): Promise<RedmineResult<{
+        issue: RedmineIssue;
+    }>>;
+    updateIssue(id: number, data: {
+        subject?: string;
+        description?: string;
+        project_id?: number | string;
+        tracker_id?: number;
+        status_id?: number;
+        priority_id?: number;
+        assigned_to_id?: number | string;
+        category_id?: number;
+        fixed_version_id?: number | string;
+        parent_issue_id?: number | string;
+        custom_fields?: {
+            id: number;
+            value: string | string[];
+        }[];
+        notes?: string;
+        private_notes?: boolean;
+        is_private?: boolean;
+        estimated_hours?: number;
+        done_ratio?: number;
+        start_date?: string;
+        due_date?: string;
+        uploads?: {
+            token: string;
+            filename: string;
+            content_type?: string;
+            description?: string;
+        }[];
+    }): Promise<RedmineResult<void>>;
+    deleteIssue(id: number): Promise<RedmineResult<void>>;
+    addIssueWatcher(issueId: number, userId: number): Promise<RedmineResult<void>>;
+    removeIssueWatcher(issueId: number, userId: number): Promise<RedmineResult<void>>;
+    listProjects(params?: {
+        include?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<RedmineResult<RedmineProjectsResponse>>;
+    getProject(id: string | number, include?: string): Promise<RedmineResult<{
+        project: RedmineProject;
+    }>>;
+    createProject(data: {
+        name: string;
+        identifier: string;
+        description?: string;
+        homepage?: string;
+        is_public?: boolean;
+        parent_id?: number | string;
+        inherit_members?: boolean;
+        default_assigned_to_id?: number;
+        default_version_id?: number;
+        tracker_ids?: number[];
+        enabled_module_names?: string[];
+        issue_custom_field_ids?: number[];
+        custom_fields?: {
+            id: number;
+            value: string | string[];
+        }[];
+    }): Promise<RedmineResult<{
+        project: RedmineProject;
+    }>>;
+    updateProject(id: string | number, data: {
+        name?: string;
+        description?: string;
+        homepage?: string;
+        is_public?: boolean;
+        parent_id?: number | string;
+        inherit_members?: boolean;
+        default_assigned_to_id?: number;
+        default_version_id?: number;
+        tracker_ids?: number[];
+        enabled_module_names?: string[];
+        issue_custom_field_ids?: number[];
+        custom_fields?: {
+            id: number;
+            value: string | string[];
+        }[];
+    }): Promise<RedmineResult<void>>;
+    deleteProject(id: string | number): Promise<RedmineResult<void>>;
+    archiveProject(id: string | number): Promise<RedmineResult<void>>;
+    unarchiveProject(id: string | number): Promise<RedmineResult<void>>;
+    listWikiPages(projectId: string | number): Promise<RedmineResult<RedmineWikiPagesResponse>>;
+    getWikiPage(projectId: string | number, pageName: string, options?: {
+        version?: number;
+        include?: string;
+    }): Promise<RedmineResult<{
+        wiki_page: RedmineWikiPage;
+    }>>;
+    createOrUpdateWikiPage(projectId: string | number, pageName: string, data: {
+        text: string;
+        comments?: string;
+        version?: number;
+        parent_title?: string;
+        uploads?: {
+            token: string;
+            filename: string;
+            content_type?: string;
+            description?: string;
+        }[];
+    }): Promise<RedmineResult<{
+        wiki_page: RedmineWikiPage;
+    }>>;
+    deleteWikiPage(projectId: string | number, pageName: string): Promise<RedmineResult<void>>;
+    getAttachment(id: number): Promise<RedmineResult<{
+        attachment: RedmineAttachment;
+    }>>;
+    deleteAttachment(id: number): Promise<RedmineResult<void>>;
+    uploadFile(filename: string, contentType: string, content: Uint8Array): Promise<RedmineResult<RedmineUploadResponse>>;
+    listProjectFiles(projectId: string | number): Promise<RedmineResult<RedmineFilesResponse>>;
+    uploadProjectFile(projectId: string | number, data: {
+        token: string;
+        version_id?: number;
+        filename?: string;
+        description?: string;
+    }): Promise<RedmineResult<void>>;
+    listIssueRelations(issueId: number): Promise<RedmineResult<RedmineRelationsResponse>>;
+    getRelation(id: number): Promise<RedmineResult<{
+        relation: RedmineRelation;
+    }>>;
+    createIssueRelation(issueId: number, data: {
+        issue_to_id: number;
+        relation_type: string;
+        delay?: number;
+    }): Promise<RedmineResult<{
+        relation: RedmineRelation;
+    }>>;
+    deleteRelation(id: number): Promise<RedmineResult<void>>;
+    listVersions(projectId: string | number): Promise<RedmineResult<RedmineVersionsResponse>>;
+    getVersion(id: number): Promise<RedmineResult<{
+        version: RedmineVersion;
+    }>>;
+    createVersion(projectId: string | number, data: {
+        name: string;
+        status?: string;
+        sharing?: string;
+        due_date?: string;
+        description?: string;
+        wiki_page_title?: string;
+    }): Promise<RedmineResult<{
+        version: RedmineVersion;
+    }>>;
+    updateVersion(id: number, data: {
+        name?: string;
+        status?: string;
+        sharing?: string;
+        due_date?: string;
+        description?: string;
+        wiki_page_title?: string;
+    }): Promise<RedmineResult<{
+        version: RedmineVersion;
+    }>>;
+    deleteVersion(id: number): Promise<RedmineResult<void>>;
+    listTrackers(): Promise<RedmineResult<RedmineTrackersResponse>>;
+    listIssueStatuses(): Promise<RedmineResult<RedmineIssueStatusesResponse>>;
+    listIssueCategories(projectId: string | number): Promise<RedmineResult<RedmineCategoriesResponse>>;
+    getIssueCategory(id: number): Promise<RedmineResult<{
+        issue_category: RedmineCategory;
+    }>>;
+    createIssueCategory(projectId: string | number, data: {
+        name: string;
+        assigned_to_id?: number;
+    }): Promise<RedmineResult<{
+        issue_category: RedmineCategory;
+    }>>;
+    updateIssueCategory(id: number, data: {
+        name?: string;
+        assigned_to_id?: number;
+    }): Promise<RedmineResult<{
+        issue_category: RedmineCategory;
+    }>>;
+    deleteIssueCategory(id: number, reassignToId?: number): Promise<RedmineResult<void>>;
+    listCustomFields(): Promise<RedmineResult<RedmineCustomFieldsResponse>>;
+    listQueries(): Promise<RedmineResult<RedmineQueriesResponse>>;
+    search(params: {
+        q: string;
+        scope?: string;
+        all_words?: boolean;
+        titles_only?: boolean;
+        open_issues?: boolean;
+        attachments?: string;
+        issues?: boolean;
+        news?: boolean;
+        documents?: boolean;
+        changesets?: boolean;
+        wiki_pages?: boolean;
+        messages?: boolean;
+        projects?: boolean;
+        limit?: number;
+        offset?: number;
+    }): Promise<RedmineResult<RedmineSearchResponse>>;
+    getMyAccount(): Promise<RedmineResult<RedmineMyAccountResponse>>;
+    listTimeEntries(params?: {
+        project_id?: string | number;
+        user_id?: number | string;
+        spent_on?: string;
+        from?: string;
+        to?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<RedmineResult<RedmineTimeEntriesResponse>>;
+    getTimeEntry(id: number): Promise<RedmineResult<{
+        time_entry: RedmineTimeEntry;
+    }>>;
+    createTimeEntry(data: {
+        issue_id?: number;
+        project_id?: string | number;
+        hours: number;
+        activity_id?: number;
+        spent_on?: string;
+        comments?: string;
+        user_id?: number;
+    }): Promise<RedmineResult<{
+        time_entry: RedmineTimeEntry;
+    }>>;
+    updateTimeEntry(id: number, data: {
+        hours?: number;
+        activity_id?: number;
+        spent_on?: string;
+        comments?: string;
+    }): Promise<RedmineResult<void>>;
+    deleteTimeEntry(id: number): Promise<RedmineResult<void>>;
+    listIssuePriorities(): Promise<RedmineResult<RedmineIssuePrioritiesResponse>>;
+    listTimeEntryActivities(): Promise<RedmineResult<RedmineTimeEntryActivitiesResponse>>;
+    listDocumentCategories(): Promise<RedmineResult<RedmineDocumentCategoriesResponse>>;
+    listUsers(params?: {
+        status?: number;
+        name?: string;
+        group_id?: number;
+        limit?: number;
+        offset?: number;
+    }): Promise<RedmineResult<RedmineUsersResponse>>;
+    getUser(id: number | "current", include?: string): Promise<RedmineResult<{
+        user: RedmineUser;
+    }>>;
+    createUser(data: {
+        login: string;
+        firstname: string;
+        lastname: string;
+        mail: string;
+        password?: string;
+        generate_password?: boolean;
+        must_change_passwd?: boolean;
+        auth_source_id?: number;
+        mail_notification?: string;
+        admin?: boolean;
+        send_information?: boolean;
+    }): Promise<RedmineResult<{
+        user: RedmineUser;
+    }>>;
+    updateUser(id: number, data: {
+        login?: string;
+        firstname?: string;
+        lastname?: string;
+        mail?: string;
+        password?: string;
+        admin?: boolean;
+        status?: number;
+    }): Promise<RedmineResult<void>>;
+    deleteUser(id: number): Promise<RedmineResult<void>>;
+    listGroups(): Promise<RedmineResult<RedmineGroupsResponse>>;
+    getGroup(id: number, include?: string): Promise<RedmineResult<{
+        group: RedmineGroup;
+    }>>;
+    createGroup(data: {
+        name: string;
+        user_ids?: number[];
+    }): Promise<RedmineResult<{
+        group: RedmineGroup;
+    }>>;
+    deleteGroup(id: number): Promise<RedmineResult<void>>;
+    addUserToGroup(groupId: number, userId: number): Promise<RedmineResult<void>>;
+    removeUserFromGroup(groupId: number, userId: number): Promise<RedmineResult<void>>;
+    listProjectMemberships(projectId: string | number, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<RedmineResult<RedmineMembershipsResponse>>;
+    getMembership(id: number): Promise<RedmineResult<{
+        membership: RedmineMembership;
+    }>>;
+    createProjectMembership(projectId: string | number, data: {
+        user_id: number;
+        role_ids: number[];
+    }): Promise<RedmineResult<{
+        membership: RedmineMembership;
+    }>>;
+    updateMembership(id: number, data: {
+        role_ids: number[];
+    }): Promise<RedmineResult<void>>;
+    deleteMembership(id: number): Promise<RedmineResult<void>>;
+    listRoles(): Promise<RedmineResult<RedmineRolesResponse>>;
+    getRole(id: number): Promise<RedmineResult<{
+        role: RedmineRole;
+    }>>;
+}