Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IssueApi

IssueApi - object-oriented interface

export

Hierarchy

  • BaseAPI
    • IssueApi

Index

Constructors

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns IssueApi

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: Configuration

Methods

  • summary

    Add a label to an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Label[]>>

  • summary

    Subscribe user to issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Add tracked time to a issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<TrackedTime>>

  • summary

    Check if user is subscribed to an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<WatchInfo>>

  • summary

    Remove all labels from an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Add a comment to an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Comment>>

  • summary

    Create an issue. If using deadline only the date will be taken into account, and time of day ignored.

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Issue>>

  • summary

    Create a label

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Label>>

  • summary

    Create a milestone

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Milestone>>

  • summary

    Delete an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Delete a comment

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Delete a comment

    deprecated
    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Remove a reaction from a comment of an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Remove a reaction from an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Delete a label

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Delete a milestone

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Delete an issue's existing stopwatch.

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Unsubscribe user from issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Delete specific tracked time

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Edit a comment

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Comment>>

  • summary

    Edit a comment

    deprecated
    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Comment>>

  • summary

    Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Issue>>

  • summary

    Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<IssueDeadline>>

  • summary

    Update a label

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Label>>

  • summary

    Update a milestone

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Milestone>>

  • summary

    Get a comment

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Comment>>

  • summary

    Get a list of reactions from a comment of an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Reaction[]>>

  • summary

    List all comments on an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Comment[]>>

  • summary

    List all comments and events on an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<TimelineComment[]>>

  • summary

    Get an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Issue>>

  • summary

    Get a list reactions of an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Reaction[]>>

  • summary

    Get a single label

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Label>>

  • summary

    Get an issue's labels

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Label[]>>

  • summary

    Get a milestone

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Milestone>>

  • summary

    Get all of a repository's opened milestones

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Milestone[]>>

  • summary

    List all comments in a repository

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Comment[]>>

  • summary

    List a repository's issues

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Issue[]>>

  • summary

    Get all of a repository's labels

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Label[]>>

  • summary

    Add a reaction to a comment of an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Reaction>>

  • summary

    Add a reaction to an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Reaction>>

  • summary

    Remove a label from an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Replace an issue's labels

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Label[]>>

  • summary

    Reset a tracked time of an issue

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Search for issues across the repositories that the user has access to

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<Issue[]>>

  • summary

    Start stopwatch on an issue.

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Stop an issue's existing stopwatch.

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Get users who subscribed on an issue.

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<User[]>>

  • summary

    List an issue's tracked times

    throws

    {RequiredError}

    memberof

    IssueApi

    Parameters

    Returns Promise<AxiosResponse<TrackedTime[]>>

Generated using TypeDoc