Class UserHandler

Hierarchy

UserHandler

Index

Constructors

Methods

addProof create find findById findByUserId list

Constructors

constructor

new UserHandler(axiosInstance): UserHandler
Parameters
- axiosInstance: AxiosInstance
Returns UserHandler
- Defined in src/client/UserHandler.ts:13

Methods

addProof

addProof(id, proof): Promise<UserReport>
Add proof to an existing report
Parameters
- id: string | bigint
  
  id of the report
- proof: string[]
  
  list of links to images/files that show proof
Returns Promise<UserReport>
- Defined in src/client/UserHandler.ts:32

create

create(report): Promise<UserReport>
Creates a new user report
Parameters
- report: UserReportCreateBody
  
  an object containing all the fields to create a report
Returns Promise<UserReport>
- Defined in src/client/UserHandler.ts:21

find

find(query): Promise<UserReport[]>
Find user reports using a query
Parameters
- query: UserFindReports
  
  query to search for
Returns Promise<UserReport[]>
- Defined in src/client/UserHandler.ts:56

findById

findById(id): Promise<UserReport>
Find a user report by id
Parameters
- id: string | bigint
  
  id of the report
Returns Promise<UserReport>
- Defined in src/client/UserHandler.ts:66

findByUserId

findByUserId(id): Promise<UserReport[]>
Find reports by a Discord user id
Parameters
- id: string
  
  Discord user id to search for
Returns Promise<UserReport[]>
- Defined in src/client/UserHandler.ts:76

list

list(options?): Promise<List<UserReport>>
List all the user reports, paginated
Parameters
- Optional options: ListOptions
  
  modify the offset or limit
Returns Promise<List<UserReport>>
- Defined in src/client/UserHandler.ts:44

Generated using TypeDoc