Class Blips

constructor

• new Blips(e621: E621<NoV2Options> | undefined, client: Client): Blips

  e621 may be omitted (pass undefined) when constructing a module standalone, without the main E621 client, to keep bundles tree-shakable. Convenience methods on models returned by this module that call back into other modules via this.e621 will throw in that case.

  Parameters

  • e621: E621<NoV2Options> | undefined
  • client: Client

  Returns Blips

Static ReadonlymoduleKey

create

• create(options: CreateBlipOptions): Promise<Blip>
  Requires Api Key Auth

  Parameters

  • options: CreateBlipOptions

  Returns Promise<Blip>

  Operation Id

  blips#create

  See

  Documentation for more details.

delete

• delete(id: number): Promise<string>
  Requires Api Key Auth

  Soft deletion. You must be the creator or Moderator+.

  Parameters

  • id: number

  Returns Promise<string>

  Operation Id

  blips#delete

  See

  Documentation for more details.

destroy

• destroy(id: number): Promise<null>
  Requires Api Key Auth

  You must be Admin+.

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  blips#destroy

  See

  Documentation for more details.

get

• get(id: number): Promise<Blip | null>

  Parameters

  • id: number

  Returns Promise<Blip | null>

  Operation Id

  blips#show

  See

  Documentation for more details.

mark

• mark(id: number, type: WarningRecordType): Promise<BlipsWarningResponse>
  Requires Api Key Auth

  You must be Moderator+.

  Parameters

  • id: number
  • type: WarningRecordType

  Returns Promise<BlipsWarningResponse>

  Operation Id

  blips#warning

  See

  Documentation for more details.

search

• search(options?: SearchBlipsOptions): Promise<Blip[]>

  Parameters

  • Optionaloptions: SearchBlipsOptions

  Returns Promise<Blip[]>

  Operation Id

  blips#index

  See

  Documentation for more details.

undelete

• undelete(id: number): Promise<string>
  Requires Api Key Auth

  You must be Moderator+.

  Parameters

  • id: number

  Returns Promise<string>

  Operation Id

  blips#undelete

  See

  Documentation for more details.

update

• update(id: number, options: UpdateBlipOptions): Promise<null>
  Requires Api Key Auth

  Unless Admin+, blips cannot be edited after 5 minutes. Marked blips cannot be edited.

  Parameters

  • id: number
  • options: UpdateBlipOptions

  Returns Promise<null>

  Operation Id

  blips#update

  See

  Documentation for more details.