Class AvoidPostings

constructor

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

  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 AvoidPostings

Static ReadonlymoduleKey

create

• create(options: CreateAvoidPostingOptions): Promise<AvoidPosting>
  Requires Api Key Auth

  Must have the bd staff user flag.

  Parameters

  • options: CreateAvoidPostingOptions

  Returns Promise<AvoidPosting>

  Operation Id

  avoid_postings#create

  See

  Documentation for more details.

delete

• delete(idOrName: string | number): Promise<null>
  Requires Api Key Auth

  Soft deletion. Must have the bd staff user flag.

  Parameters

  • idOrName: string | number

  Returns Promise<null>

  Operation Id

  avoid_postings#delete

  See

  Documentation for more details.

destroy

• destroy(idOrName: string | number): Promise<null>
  Requires Api Key Auth

  Must have the bd staff user flag.

  Parameters

  • idOrName: string | number

  Returns Promise<null>

  Operation Id

  avoid_postings#destroy

  See

  Documentation for more details.

get

• get(idOrName: string | number): Promise<AvoidPosting | null>

  Parameters

  • idOrName: string | number

  Returns Promise<AvoidPosting | null>

  Operation Id

  avoid_postings#show

  See

  Documentation for more details.

search

• search(options?: SearchAvoidPostingsOptions): Promise<AvoidPosting[]>

  Parameters

  • Optionaloptions: SearchAvoidPostingsOptions

  Returns Promise<AvoidPosting[]>

  Operation Id

  avoid_postings#index

  See

  Documentation for more details.

undelete

• undelete(idOrName: string | number): Promise<null>
  Requires Api Key Auth

  Must have the bd staff user flag.

  Parameters

  • idOrName: string | number

  Returns Promise<null>

  Operation Id

  avoid_postings#undelete

  See

  Documentation for more details.

update

• update(
      idOrName: string | number,
      options?: UpdateAvoidPostingOptions,
  ): Promise<null>
  Requires Api Key Auth

  Must have the bd staff user flag.

  Parameters

  • idOrName: string | number
  • Optionaloptions: UpdateAvoidPostingOptions

  Returns Promise<null>

  Operation Id

  avoid_postings#update

  See

  Documentation for more details.