From 8411a3f1e5f6d3eb467c972bf1b6a91e5acccf7e Mon Sep 17 00:00:00 2001 From: Aeolun Date: Mon, 5 Feb 2024 10:40:55 +0000 Subject: [PATCH] deploy: 93d38fd1947361cd7df126a3e423aa139c9612c9 --- classes/JiraApi.html | 242 +++++++++++++++++----------------- index.html | 2 +- interfaces/MakeUrlParams.html | 4 +- types/AxiosOrStrict.html | 2 +- types/JiraApiOptions.html | 2 +- types/PaginationParams.html | 2 +- types/WithAxios.html | 2 +- types/WithStrictSSL.html | 2 +- 8 files changed, 129 insertions(+), 129 deletions(-) diff --git a/classes/JiraApi.html b/classes/JiraApi.html index e1554c4..ad04757 100644 --- a/classes/JiraApi.html +++ b/classes/JiraApi.html @@ -1,6 +1,6 @@ JiraApi | ts-jira-client

Class JiraApi

Wrapper for the JIRA Rest Api https://docs.atlassian.com/jira/REST/6.4.8/

-

Constructors

constructor +

Constructors

constructor

Properties

apiVersion axios base @@ -137,11 +137,11 @@ updatedWorklogs upsertFieldOption

Constructors

constructor

Properties

apiVersion

apiVersion: number

axios

axios: AxiosInstance

base

base: string

baseOptions

baseOptions: AxiosRequestConfig<any>

host

host: string

Optional httpsAgent

httpsAgent?: Agent

intermediatePath

intermediatePath: string

port

port: number

protocol

protocol: string

webhookVersion

webhookVersion: string

Methods

addAttachmentOnIssue

  • addAttachmentOnIssue(issueId, readStream): Promise<unknown>

  • Add attachment to a Issue +

    Parameters

    Returns JiraApi

Properties

apiVersion

apiVersion: number

axios

axios: AxiosInstance

base

base: string

baseOptions

baseOptions: AxiosRequestConfig<any>

host

host: string

Optional httpsAgent

httpsAgent?: Agent

intermediatePath

intermediatePath: string

port

port: number

protocol

protocol: string

webhookVersion

webhookVersion: string

Methods

addAttachmentOnIssue

  • addAttachmentOnIssue(issueId, readStream): Promise<unknown>

  • Add attachment to a Issue Jira Doc

    Parameters

    • issueId: string

      issue id

    • readStream: Buffer

      readStream object from fs

      -

    Returns Promise<unknown>

addComment

  • addComment(issueId, comment): Promise<unknown>

  • Add a comment to an issue +

Returns Promise<unknown>

addComment

  • addComment(issueId, comment): Promise<unknown>

  • Add a comment to an issue Jira Doc

    Parameters

    • issueId: string

      Issue to add a comment to

    • comment: {
          author?: {
              accountId?: string;
              accountType?: string;
              active?: boolean;
              avatarUrls?: {
                  16x16?: string;
                  24x24?: string;
                  32x32?: string;
                  48x48?: string;
              };
              displayName?: string;
              emailAddress?: string;
              key?: string;
              name?: string;
              self?: string;
              timeZone?: string;
          };
          body?: unknown;
          created?: string;
          id?: string;
          jsdAuthorCanSeeRequest?: boolean;
          jsdPublic?: boolean;
          properties?: {
              key?: string;
              value?: unknown;
          }[];
          renderedBody?: string;
          self?: string;
          updateAuthor?: {
              accountId?: string;
              accountType?: string;
              active?: boolean;
              avatarUrls?: {
                  16x16?: string;
                  24x24?: string;
                  32x32?: string;
                  48x48?: string;
              };
              displayName?: string;
              emailAddress?: string;
              key?: string;
              name?: string;
              self?: string;
              timeZone?: string;
          };
          updated?: string;
          visibility?: {
              identifier?: string;
              type?: "group" | "role";
              value?: string;
              [key: string]: unknown;
          };
          [key: string]: unknown;
      }

      string containing comment

      @@ -198,10 +198,10 @@
      • [key: string]: unknown
      • Optional identifier?: string

        Description

        The ID of the group or the name of the role that visibility of this item is restricted to.

      • Optional type?: "group" | "role"

        Description

        Whether visibility of this item is restricted to a group or role.

      • Optional value?: string

        Description

        The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.

        -

Returns Promise<unknown>

addIssueToSprint

  • addIssueToSprint(issueId, sprintId): Promise<unknown>

  • Add an issue to the project's current sprint

    +

Returns Promise<unknown>

addIssueToSprint

addNewComponent

Returns Promise<unknown>

addNewComponent

Returns Promise<unknown>

addNewIssue

Returns Promise<unknown>

addNewIssue

  • Optional update?: {
        [key: string]: components["schemas"]["FieldUpdateOperation"][];
    }

    Description

    A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.

    -
    • [key: string]: components["schemas"]["FieldUpdateOperation"][]

    • Returns Promise<unknown>

    addWatcher

    Returns Promise<unknown>

    addWatcher

    addWorklog

    Returns Promise<unknown>

    addWorklog

    Returns Promise<unknown>

    createBoard

    Returns Promise<unknown>

    createBoard

    createCustomField

    Returns Promise<unknown>

    createCustomField

    Returns Promise<unknown>

    createFieldOption

    Returns Promise<unknown>

    createFieldOption

  • Optional properties?: {
        [key: string]: unknown;
    }

    Description

    The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.

    • [key: string]: unknown
  • value: string

    Description

    The option's name, which is displayed in Jira.

    -

    • Returns Promise<unknown>

    createProject

    Returns Promise<unknown>

    createProject

    createRemoteLink

    Returns Promise<unknown>

    createRemoteLink

    Returns Promise<unknown>

    createUser

    Returns Promise<unknown>

    createUser

    createVersion

    Returns Promise<unknown>

    createVersion

    deleteAttachment

    Returns Promise<unknown>

    deleteAttachment

    deleteBoard

    Returns Promise<unknown>

    deleteBoard

    deleteBoardProperty

    Returns Promise<unknown>

    deleteBoardProperty

    deleteComment

    Returns Promise<unknown>

    deleteComment

    deleteComponent

    Returns Promise<unknown>

    deleteComponent

    deleteFieldOption

    Returns Promise<unknown>

    deleteFieldOption

    deleteIssue

    Returns Promise<unknown>

    deleteIssue

    deleteIssueLink

    Returns Promise<unknown>

    deleteIssueLink

    deleteRemoteLink

    Returns Promise<unknown>

    deleteRemoteLink

    deleteVersion

    Returns Promise<unknown>

    deleteVersion

    deleteWebhook

    Returns Promise<unknown>

    deleteWebhook

    deleteWorklog

    Returns Promise<unknown>

    deleteWorklog

    doRawRequest

    doRequest

    downloadAttachment

    Returns Promise<unknown>

    doRawRequest

    doRequest

    downloadAttachment

    downloadAvatar

    Returns Promise<Buffer>

    downloadAvatar

    downloadUserAvatar

    Returns Promise<{
        content: Buffer;
        mimeType: string;
    }>

    downloadUserAvatar

    estimateIssueForBoard

    Returns Promise<{
        content: Buffer;
        mimeType: string;
    }>

    estimateIssueForBoard

    findIssue

    Returns Promise<unknown>

    findIssue

    genericAgileGet

    Returns Promise<unknown>

    genericAgileGet

    genericGet

    Returns Promise<unknown>

    genericGet

    getAllBoards

    Returns Promise<unknown>

    getAllBoards

    getAllSprints

    Returns Promise<unknown>

    getAllSprints

    getAllVersions

    Returns Promise<unknown>

    getAllVersions

    getBacklogForBoard

    Returns Promise<unknown>

    getBacklogForBoard

    getBoard

    Returns Promise<unknown>

    getBoard

    getBoardIssuesForEpic

    Returns Promise<unknown>

    getBoardIssuesForEpic

    getBoardIssuesForSprint

    Returns Promise<unknown>

    getBoardIssuesForSprint

    getBoardPropertiesKeys

    Returns Promise<unknown>

    getBoardPropertiesKeys

    getBoardProperty

    Returns Promise<unknown>

    getBoardProperty

    getComment

    Returns Promise<unknown>

    getComment

    getComments

    Returns Promise<unknown>

    getComments

    getConfiguration

    Returns Promise<unknown>

    getConfiguration

    getCurrentUser

    Returns Promise<unknown>

    getCurrentUser

    getDevStatusDetail

    getDevStatusDetail

    getDevStatusSummary

    Returns Promise<unknown>

    getDevStatusSummary

    getEpic

    Returns Promise<unknown>

    getEpic

    getEpics

    Returns Promise<unknown>

    getEpics

    getFieldOption

    Returns Promise<unknown>

    getFieldOption

    getFilter

    Returns Promise<unknown>

    getFilter

    getIssue

    Returns Promise<unknown>

    getIssue

    getIssueChangelog

    Returns Promise<unknown>

    getIssueChangelog

    getIssueCreateMetaFields

    getIssueCreateMetaProjectIssueTypes

    getIssueCreateMetadata

    Returns Promise<unknown>

    getIssueCreateMetaFields

    getIssueCreateMetaProjectIssueTypes

    getIssueCreateMetadata

    getIssueEstimationForBoard

    Returns Promise<unknown>

    getIssueEstimationForBoard

    getIssueProperty

    Returns Promise<unknown>

    getIssueProperty

    getIssueWatchers

    Returns Promise<unknown>

    getIssueWatchers

    getIssueWorklogs

    Returns Promise<unknown>

    getIssueWorklogs

    getIssuesForBacklog

    Returns Promise<unknown>

    getIssuesForBacklog

    getIssuesForBoard

    Returns Promise<unknown>

    getIssuesForBoard

    getIssuesForEpic

    Returns Promise<unknown>

    getIssuesForEpic

    getMembersOfGroup

    Returns Promise<unknown>

    getMembersOfGroup

    getProject

    Returns Promise<unknown>

    getProject

    getProjects

    Returns Promise<unknown>

    getProjects

    getProjectsFull

    Returns Promise<unknown>

    getProjectsFull

    getRemoteLinks

    Returns Promise<unknown>

    getRemoteLinks

    getServerInfo

    Returns Promise<unknown>

    getServerInfo

    getSprint

    getSprint

    getSprintIssues

    Returns Promise<unknown>

    getSprintIssues

    getUnresolvedIssueCount

    Returns Promise<unknown>

    getUnresolvedIssueCount

    getUser

    Returns Promise<number>

    getUser

    getUsers

    Returns Promise<unknown>

    getUsers

    getUsersInGroup

    Returns Promise<unknown>

    getUsersInGroup

    getUsersIssues

    Returns Promise<unknown>

    Deprecated

    getUsersIssues

    getVersion

    Returns Promise<unknown>

    getVersion

    getVersions

    Returns Promise<unknown>

    getVersions

    getWebhook

    Returns Promise<unknown>

    getWebhook

    getWorkflowScheme

    getWorkflows

    getWorklogs

    Returns Promise<unknown>

    getWorkflowScheme

    getWorkflows

    getWorklogs

    issueEditMeta

    Returns Promise<unknown>

    issueEditMeta

    issueLink

    Returns Promise<unknown>

    issueLink

    issueNotify

    Returns Promise<unknown>

    issueNotify

    Returns Promise<unknown>

    listComponents

    Returns Promise<unknown>

    listComponents

    listFieldOptions

    Returns Promise<unknown>

    listFieldOptions

    listFields

    Returns Promise<unknown>

    listFields

    listIssueLinkTypes

    listIssueLinkTypes

    listIssueTypes

    listIssueTypes

    listPriorities

    listPriorities

    listProjects

    listProjects

    listSprints

    listSprints

    listStatus

    Returns Promise<unknown>

    listStatus

    listTransitions

    listTransitions

    listWebhooks

    Returns Promise<unknown>

    listWebhooks

    makeAgileUri

    makeDevStatusUri

    makeAgileUri

    makeDevStatusUri

    makeRequestHeader

    makeRequestHeader

    makeUri

    Returns AxiosRequestConfig<any>

    makeUri

    makeWebhookUri

    Returns string

    makeWebhookUri

    moveIssuesToEpic

    Returns string

    moveIssuesToEpic

    moveToBacklog

    Returns Promise<unknown>

    moveToBacklog

    moveVersion

    Returns Promise<unknown>

    moveVersion

    partiallyUpdateEpic

    Returns Promise<unknown>

    partiallyUpdateEpic

    rankEpics

    Returns Promise<unknown>

    rankEpics

    rankIssues

    Returns Promise<unknown>

    rankIssues

    registerWebhook

    Returns Promise<unknown>

    registerWebhook

    relatedIssueCounts

    Returns Promise<unknown>

    relatedIssueCounts

    searchJira

    Returns Promise<unknown>

    searchJira

    searchUsers

    Returns Promise<unknown>

    searchUsers

    setBoardProperty

    Returns Promise<unknown>

    setBoardProperty

    transitionIssue

    Returns Promise<unknown>

    transitionIssue

  • Optional update?: {
        [key: string]: components["schemas"]["FieldUpdateOperation"][];
    }

    Description

    A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.

    -
    • [key: string]: components["schemas"]["FieldUpdateOperation"][]

    • Returns Promise<unknown>

    updateAssignee

    Returns Promise<unknown>

    updateAssignee

    updateAssigneeWithId

    Returns Promise<unknown>

    updateAssigneeWithId

    updateComment

    Returns Promise<unknown>

    updateComment

    updateComponent

    Returns Promise<unknown>

    updateComponent

    Returns Promise<unknown>

    updateIssue

    Returns Promise<unknown>

    updateIssue

    Returns Promise<unknown>

    updateVersion

    Returns Promise<unknown>

    updateVersion

    updateWorklog

    Returns Promise<unknown>

    updateWorklog

    Returns Promise<unknown>

    updatedWorklogs

    Returns Promise<unknown>

    updatedWorklogs

    upsertFieldOption

    Returns Promise<unknown>

    upsertFieldOption

    Returns Promise<unknown>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<unknown>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index 8747609..5e04cf3 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -ts-jira-client

    ts-jira-client

    Typescript JIRA API for node.js

    A Typescript wrapper for the Jira Rest API, now in Typescript. I had this as a fork of jira-client for a while, but I felt the need to completely split it up to modernize it (as well as give myself an easier time deploying).

    +ts-jira-client

    ts-jira-client

    Typescript JIRA API for node.js

    A Typescript wrapper for the Jira Rest API, now in Typescript. I had this as a fork of jira-client for a while, but I felt the need to completely split it up to modernize it (as well as give myself an easier time deploying).

    I've tried to keep the api as close to the original api as possible, but sometimes I've had to make compromises. Where possible any legacy calls have been removed, and replaced with what made most sense considering the latest versions of Jira Datacenter, Cloud, Software and Service Desk.

    [!WARNING]
    Types have been sourced wherever they exist (cloud has more type definitions, either in docs or openapi, than server/datacenter, but no guarantee they are compatible).

    diff --git a/interfaces/MakeUrlParams.html b/interfaces/MakeUrlParams.html index 26b1bfc..9563429 100644 --- a/interfaces/MakeUrlParams.html +++ b/interfaces/MakeUrlParams.html @@ -1,5 +1,5 @@ -MakeUrlParams | ts-jira-client

    Interface MakeUrlParams

    interface MakeUrlParams {
        encode?: boolean;
        intermediatePath?: string;
        pathname?: string;
        query?: Record<string, string | number | boolean>;
    }

    Properties

    encode? +MakeUrlParams | ts-jira-client

    Interface MakeUrlParams

    interface MakeUrlParams {
        encode?: boolean;
        intermediatePath?: string;
        pathname?: string;
        query?: Record<string, string | number | boolean>;
    }

    Properties

    encode? intermediatePath? pathname? query? -

    Properties

    Optional encode

    encode?: boolean

    Optional intermediatePath

    intermediatePath?: string

    Optional pathname

    pathname?: string

    Optional query

    query?: Record<string, string | number | boolean>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional encode

    encode?: boolean

    Optional intermediatePath

    intermediatePath?: string

    Optional pathname

    pathname?: string

    Optional query

    query?: Record<string, string | number | boolean>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/AxiosOrStrict.html b/types/AxiosOrStrict.html index 825a154..54e1073 100644 --- a/types/AxiosOrStrict.html +++ b/types/AxiosOrStrict.html @@ -1 +1 @@ -AxiosOrStrict | ts-jira-client

    Type alias AxiosOrStrict

    AxiosOrStrict: WithStrictSSL | WithAxios

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AxiosOrStrict | ts-jira-client

    Type alias AxiosOrStrict

    AxiosOrStrict: WithStrictSSL | WithAxios

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/JiraApiOptions.html b/types/JiraApiOptions.html index 9d4f86a..0b3f417 100644 --- a/types/JiraApiOptions.html +++ b/types/JiraApiOptions.html @@ -1 +1 @@ -JiraApiOptions | ts-jira-client

    Type alias JiraApiOptions

    JiraApiOptions: {
        apiVersion?: 1 | 2 | 3;
        base?: string;
        baseOptions?: AxiosRequestConfig;
        bearer?: string;
        host: string;
        intermediatePath?: string;
        password?: string;
        port?: number;
        protocol?: "http" | "https";
        timeout?: number;
        username?: string;
        webHookVersion?: string;
    } & AxiosOrStrict

    Type declaration

    • Optional apiVersion?: 1 | 2 | 3
    • Optional base?: string
    • Optional baseOptions?: AxiosRequestConfig
    • Optional bearer?: string
    • host: string
    • Optional intermediatePath?: string
    • Optional password?: string
    • Optional port?: number
    • Optional protocol?: "http" | "https"
    • Optional timeout?: number
    • Optional username?: string
    • Optional webHookVersion?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JiraApiOptions | ts-jira-client

    Type alias JiraApiOptions

    JiraApiOptions: {
        apiVersion?: 1 | 2 | 3;
        base?: string;
        baseOptions?: AxiosRequestConfig;
        bearer?: string;
        host: string;
        intermediatePath?: string;
        password?: string;
        port?: number;
        protocol?: "http" | "https";
        timeout?: number;
        username?: string;
        webHookVersion?: string;
    } & AxiosOrStrict

    Type declaration

    • Optional apiVersion?: 1 | 2 | 3
    • Optional base?: string
    • Optional baseOptions?: AxiosRequestConfig
    • Optional bearer?: string
    • host: string
    • Optional intermediatePath?: string
    • Optional password?: string
    • Optional port?: number
    • Optional protocol?: "http" | "https"
    • Optional timeout?: number
    • Optional username?: string
    • Optional webHookVersion?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/PaginationParams.html b/types/PaginationParams.html index d1a8e33..194653e 100644 --- a/types/PaginationParams.html +++ b/types/PaginationParams.html @@ -1 +1 @@ -PaginationParams | ts-jira-client

    Type alias PaginationParams

    PaginationParams: {
        expand?: string[];
        fields?: string[];
        maxResults?: number;
        startAt?: number;
    }

    Type declaration

    • Optional expand?: string[]
    • Optional fields?: string[]
    • Optional maxResults?: number
    • Optional startAt?: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PaginationParams | ts-jira-client

    Type alias PaginationParams

    PaginationParams: {
        expand?: string[];
        fields?: string[];
        maxResults?: number;
        startAt?: number;
    }

    Type declaration

    • Optional expand?: string[]
    • Optional fields?: string[]
    • Optional maxResults?: number
    • Optional startAt?: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WithAxios.html b/types/WithAxios.html index ff1b6ec..8c8f5c7 100644 --- a/types/WithAxios.html +++ b/types/WithAxios.html @@ -1 +1 @@ -WithAxios | ts-jira-client

    Type alias WithAxios

    WithAxios: {
        axios?: AxiosInstance;
        ca?: undefined;
        strictSSL?: undefined;
    }

    Type declaration

    • Optional axios?: AxiosInstance
    • Optional ca?: undefined
    • Optional strictSSL?: undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WithAxios | ts-jira-client

    Type alias WithAxios

    WithAxios: {
        axios?: AxiosInstance;
        ca?: undefined;
        strictSSL?: undefined;
    }

    Type declaration

    • Optional axios?: AxiosInstance
    • Optional ca?: undefined
    • Optional strictSSL?: undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WithStrictSSL.html b/types/WithStrictSSL.html index c6b6ff1..3fcf0db 100644 --- a/types/WithStrictSSL.html +++ b/types/WithStrictSSL.html @@ -1 +1 @@ -WithStrictSSL | ts-jira-client

    Type alias WithStrictSSL

    WithStrictSSL: {
        axios?: undefined;
        ca?: string;
        strictSSL?: boolean;
    }

    Type declaration

    • Optional axios?: undefined
    • Optional ca?: string
    • Optional strictSSL?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WithStrictSSL | ts-jira-client

    Type alias WithStrictSSL

    WithStrictSSL: {
        axios?: undefined;
        ca?: string;
        strictSSL?: boolean;
    }

    Type declaration

    • Optional axios?: undefined
    • Optional ca?: string
    • Optional strictSSL?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file