shared/server-commands/videos/blacklist-command.ts

   1
   2 import { HttpStatusCode, ResultList, VideoBlacklist, VideoBlacklistType } from '@shared/models'
   3 import { AbstractCommand, OverrideCommandOptions } from '../shared'
   4
   5 export class BlacklistCommand extends AbstractCommand {
   6
   7   add (options: OverrideCommandOptions & {
   8     videoId: number | string
   9     reason?: string
  10     unfederate?: boolean
  11   }) {
  12     const { videoId, reason, unfederate } = options
  13     const path = '/api/v1/videos/' + videoId + '/blacklist'
  14
  15     return this.postBodyRequest({
  16       ...options,
  17
  18       path,
  19       fields: { reason, unfederate },
  20       implicitToken: true,
  21       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
  22     })
  23   }
  24
  25   update (options: OverrideCommandOptions & {
  26     videoId: number | string
  27     reason?: string
  28   }) {
  29     const { videoId, reason } = options
  30     const path = '/api/v1/videos/' + videoId + '/blacklist'
  31
  32     return this.putBodyRequest({
  33       ...options,
  34
  35       path,
  36       fields: { reason },
  37       implicitToken: true,
  38       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
  39     })
  40   }
  41
  42   remove (options: OverrideCommandOptions & {
  43     videoId: number | string
  44   }) {
  45     const { videoId } = options
  46     const path = '/api/v1/videos/' + videoId + '/blacklist'
  47
  48     return this.deleteRequest({
  49       ...options,
  50
  51       path,
  52       implicitToken: true,
  53       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
  54     })
  55   }
  56
  57   list (options: OverrideCommandOptions & {
  58     sort?: string
  59     type?: VideoBlacklistType
  60   } = {}) {
  61     const { sort, type } = options
  62     const path = '/api/v1/videos/blacklist/'
  63
  64     const query = { sort, type }
  65
  66     return this.getRequestBody<ResultList<VideoBlacklist>>({
  67       ...options,
  68
  69       path,
  70       query,
  71       implicitToken: true,
  72       defaultExpectedStatus: HttpStatusCode.OK_200
  73     })
  74   }
  75 }