Class StaffFiles

constructor

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

  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 StaffFiles

Static ReadonlymoduleKey

create

• create(options: CreateStaffFileOptions): Promise<StaffFile>
  Requires Api Key Auth

  You must be Staff+

  Parameters

  • options: CreateStaffFileOptions

  Returns Promise<StaffFile>

  Operation Id

  staff/files#create

  See

  Documentation for more details.

delete

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

  You must be Admin+ if you did not created the file, else Staff+

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  staff/files#destroy

  See

  Documentation for more details.

get

• get(id: number): Promise<StaffFile>
  Requires Api Key Auth

  You must be Staff+.

  Parameters

  • id: number

  Returns Promise<StaffFile>

  Operation Id

  staff/files#show

  See

  Documentation for more details.

search

• search(options?: SearchStaffFilesOptions): Promise<StaffFile[]>
  Requires Api Key Auth

  You must be Staff+.

  Parameters

  • Optionaloptions: SearchStaffFilesOptions

  Returns Promise<StaffFile[]>

  Operation Id

  staff/files#index

  See

  Documentation for more details.

update

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

  You must be Admin+ if you did not create the file, else Staff+

  Parameters

  • id: number
  • options: UpdateStaffFileOptions

  Returns Promise<null>

  Operation Id

  staff/files#update

  See

  Documentation for more details.