Class UserNameChangeRequests

Hierarchy (View Summary)

Base
- UserNameChangeRequests

Index

Constructors

Methods

create delete get search

Constructors

constructor

new UserNameChangeRequests(e621: E621, client: Client): UserNameChangeRequests
Parameters
- e621: E621
- client: Client
Returns UserNameChangeRequests
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:20

Methods

create

create(options: CreateUserNameChangeRequestOptions): Promise<unknown>
Requires Api Key Auth
Create User Name Change Request
Parameters
- options: CreateUserNameChangeRequestOptions
Returns Promise<unknown>

Operation Id
user_name_change_requests#create

See
Documentation for more details.
- Defined in lib/modules/UserNameChangeRequests.ts:26

delete

delete(id: number): Promise<unknown>
Requires Api Key Auth
Delete User Name Change Request

You must be Moderator+.
Parameters
- id: number
Returns Promise<unknown>

Operation Id
user_name_change_requests#destroy

See
Documentation for more details.
- Defined in lib/modules/UserNameChangeRequests.ts:45

get

get(id: number): Promise<UserNameChangeRequest | null>
Requires Api Key Auth
Get User Name Change Request

You must be the creator of the request or Moderator+.
Parameters
- id: number
Returns Promise<UserNameChangeRequest | null>

Operation Id
user_name_change_requests#show

See
Documentation for more details.
- Defined in lib/modules/UserNameChangeRequests.ts:64

search

search(
options?: SearchUserNameChangeRequestsOptions,
): Promise<UserNameChangeRequest[]>
Requires Api Key Auth
User Name Change Requests Index

You must be Moderator+.
Parameters
- Optionaloptions: SearchUserNameChangeRequestsOptions
Returns Promise<UserNameChangeRequest[]>

Operation Id
user_name_change_requests#index

See
Documentation for more details.
- Defined in lib/modules/UserNameChangeRequests.ts:83