Sentry API

  • API Docs for Version: 0.1.0

    • Show:

    Releases

    Provides methods for interacting with Releases in the Sentry API.

    Table of Contents

    Constructor

    Releases
    (
    • client
    )

    Defined in lib/releases.js:3

    Parameters:

    Methods

    create
    (
    • orgSlug
    • projectSlug
    • body
    • callback
    )
    Promise

    Defined in lib/releases.js:29

    Create a new release.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • body Object
      • version String

        A version identifier for this release. Can be a version number, a commit hash etc.

      • ref String

        Aan optional commit reference. This is useful if a tagged version has been provided.

      • url String

        A URL that points to the release. This can be the path to an online interface to the sourcecode for instance.

      • dateStarted Date

        An optional date that indicates when the release process started.

      • dateReleased Date

        An optional date that indicates when the release went live. If not provided the current time is assumed.

    • callback Function

    Returns:

    Promise
    createFile
    (
    • orgSlug
    • projectSlug
    • version
    • formData
    • callback
    )
    Promise

    Defined in lib/releases.js:115

    Upload a new file.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • version String

      Release version.

    • formData Object
      • name String

        The name (full path) of the file.

      • file File

        The multipart encoded file.

      • header String

        This parameter can be supplied multiple times to attach headers to the file. Each header is a string in the format key:value. For instance it can be used to define a content type.

    • callback Function

    Returns:

    Promise
    delete
    (
    • orgSlug
    • projectSlug
    • version
    • callback
    )
    Promise

    Defined in lib/releases.js:49

    Delete a release.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • version String

      Release version.

    • callback Function

    Returns:

    Promise
    deleteFile
    (
    • orgSlug
    • projectSlug
    • version
    • fileId
    • callback
    )
    Promise

    Defined in lib/releases.js:137

    Delete a file.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • version String

      Release version.

    • fileId String

      The ID of the file to delete.

    • callback Function

    Returns:

    Promise
    files
    (
    • orgSlug
    • projectSlug
    • version
    • callback
    )
    Promise

    Defined in lib/releases.js:84

    List all files.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • version String

      Release version.

    • callback Function

    Returns:

    Promise
    get
    (
    • orgSlug
    • projectSlug
    • version
    • callback
    )
    Promise

    Defined in lib/releases.js:14

    Retrieve a release.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • version String

      Release version.

    • callback Function

    Returns:

    Promise
    getFile
    (
    • orgSlug
    • projectSlug
    • version
    • fileID
    • callback
    )
    Promise

    Defined in lib/releases.js:99

    Retrieve a file.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • version String

      Release version.

    • fileID String

      File ID.

    • callback Function

    Returns:

    Promise
    update
    (
    • orgSlug
    • projectSlug
    • version
    • body
    • callback
    )
    Promise

    Defined in lib/releases.js:64

    Update a release.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • version String

      Release version.

    • body Object
      • ref String

        Aan optional commit reference. This is useful if a tagged version has been provided.

      • url String

        A URL that points to the release. This can be the path to an online interface to the sourcecode for instance.

      • dateStarted Date

        An optional date that indicates when the release process started.

      • dateReleased Date

        An optional date that indicates when the release went live. If not provided the current time is assumed.

    • callback Function

    Returns:

    Promise
    updateFile
    (
    • orgSlug
    • projectSlug
    • version
    • fileId
    • body
    • callback
    )
    Promise

    Defined in lib/releases.js:153

    Update a file.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • version String

      Release version.

    • fileId String

      The ID of the file to update.

    • body Object
      • name String

        The new name of the file.

    • callback Function

    Returns:

    Promise