Queue

currentQueue

addSong (post)

  • route: api/commands/currentQueue/addSong
  • req:
    • body:
      • queueItem
  • res:
    • 200: okay
      • JSON:
        • itemIsAlreadyInQueue: Boolean
        • aleadyQueuedItem: QueueItem
        • queueIsFull: Boolean
        • spot: Int
    • 422: invalid parameters
    • 500: internal error

clearQueue (post)

  • route: api/commands/currentQueue/clearQueue
  • req:
    • params:
      • guildID
  • res:
    • 200: okay
      • numOfRemovedSongs : Boolean
    • 422: invalid parameters
    • 500: internal error

getQueue (get)

  • route: api/commands/currentQueue/getQueue
  • req:
    • params:
      • guildID
  • res:
    • 200: okay
      • JSON:
        • queueItems: Array
    • 422: invalid parameters
    • 500: internal error

getSongAt (get)

  • route: api/commands/currentQueue/getSongAt
  • req:
    • params:
      • guildID
  • res:
    • 200: okay

      • JSON:
        • queueItem: QueueItem
    • 422: invalid parameters

    • 500: internal error

pullSong (post)

  • route: api/commands/currentQueue/pullSong
  • req:
    • params:
      • guildID
  • res:
    • 200: okay

      • queueItem: QueueItem
    • 422: invalid parameters

    • 500: internal error

replaceSong (post)

  • route: api/commands/currentQueue/replaceSong
  • req:
    • params:
      • guildID
    • JSON:
      • queueItem
  • res:
    • 200: okay
    • 422: invalid parameters
    • 500: internal error

oldQueue

addSong (post)

  • route: api/commands/oldQueue/addSong
  • req:
    • JSON:
      • queueItem
  • res:
    • 200: okay

    • 422: invalid parameters

    • 500: internal error

getCurrentSong (get)

  • route: api/commands/oldQueue/getCurrentSong
  • req:
    • params:
      • guildID
  • res:
    • 200: okay

      • JSON:
        • queueItem: QueueItem
    • 422: invalid parameters

    • 500: internal error

getQueue (get)

  • route: api/commands/oldQueue/getQueue
  • req:
    • params:
      • guildID
  • res:
    • 200: okay
      • JSON:
        • queueItems: Array
    • 422: invalid parameters
    • 500: internal error

update (post)

  • route: api/commands/oldQueue/update
  • req:
    • params:
      • likes: Array
      • dislikes: Array
      • saves: Array
      • guildID: String
  • res:
    • 200: okay
      • Params (only if updated):
        • likes: Int
        • dislikes: Int
        • saves: Int
      • JSON:
        • interactions: QueueItem.Interactions
    • 422: invalid parameters
    • 500: internal error