Class RESTClient`Internal`

A client for interacting with the Eludris REST API.

Hierarchy

RESTClient

Constructors

constructor

new RESTClient(apiUrl): RESTClient
Create a new REST client.
Parameters
- apiUrl: string
  
  The base api URL to use.
Returns RESTClient
Example
```
import { RESTClient } from 'eludris.js';

  const rest = new RESTClient({});
```
- Defined in client.ts:57

Properties

apiUrl

apiUrl: string

The base URL used for requests.

authToken

authToken: undefined | string = undefined

The auth token used.

instanceInfo

instanceInfo: undefined | InstanceInfo = undefined

The instance info.

rateLimitBuckets

rateLimitBuckets: Map<ValidRoutes, {
remaining: number;
reset_at: number;
}> = ...

The rate limit buckets.

Type declaration

remaining: number
reset_at: number

Methods

createMessage

createMessage(message): Promise<Message>
Parameters
- message: MessageCreate
Returns Promise<Message>
- Defined in client.ts:249

createPasswordResetCode

createPasswordResetCode(createPasswordResetCode): Promise<void>
Parameters
- createPasswordResetCode: CreatePasswordResetCode
Returns Promise<void>
- Defined in client.ts:298

createSession

createSession(sessionCreate): Promise<SessionCreated>
Parameters
- sessionCreate: SessionCreate
Returns Promise<SessionCreated>
- Defined in client.ts:261

createUser

createUser(userCreate): Promise<User>
Parameters
- userCreate: UserCreate
Returns Promise<User>
- Defined in client.ts:312

deleteSession

deleteSession(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
  sessionId: number;
  } & PasswordDeleteCredentials
Returns Promise<void>
- Defined in client.ts:273

deleteUser

deleteUser(creds): Promise<void>
Parameters
- creds: PasswordDeleteCredentials
Returns Promise<void>
- Defined in client.ts:324

downloadAttachment

downloadAttachment(__namedParameters): Promise<Blob>
Parameters
- __namedParameters: {
  id: number;
  }
  - id: number
Returns Promise<Blob>
- Defined in client.ts:186

downloadFile

downloadFile(__namedParameters): Promise<Blob>
Parameters
- __namedParameters: {
  bucket: string;
  id: number;
  }
  - bucket: string
  - id: number
Returns Promise<Blob>
- Defined in client.ts:171

downloadStaticFile

downloadStaticFile(__namedParameters): Promise<Blob>
Parameters
- __namedParameters: {
  name: string;
  }
  - name: string
Returns Promise<Blob>
- Defined in client.ts:193

`Private` fetch

fetch(to, route, path, options?): Promise<Response>
Parameters
- to: "api" | "cdn"
- route: ValidRoutes
- path: string
- options: RequestInit = ...
Returns Promise<Response>
- Defined in client.ts:61

`Private` fetchJson

fetchJson<T>(baseUrl, route, path, options?): Promise<T>
Type Parameters
- T
Parameters
- baseUrl: "api" | "cdn"
- route: ValidRoutes
- path: string
- options: RequestInit = {}
Returns Promise<T>
- Defined in client.ts:124

getAttachmentData

getAttachmentData(__namedParameters): Promise<FileData>
Parameters
- __namedParameters: {
  id: number;
  }
  - id: number
Returns Promise<FileData>
- Defined in client.ts:202

getInstanceInfo

getInstanceInfo(__namedParameters): Promise<InstanceInfo>
Parameters
- __namedParameters: {
  withRateLimits: boolean;
  }
  - withRateLimits: boolean
Returns Promise<InstanceInfo>
- Defined in client.ts:237

getSessions

getSessions(): Promise<Session[]>
Returns Promise<Session[]>
- Defined in client.ts:290

getUser

getUser(__namedParameters): Promise<User>
Parameters
- __namedParameters: {
  userId: number;
  }
  - userId: number
Returns Promise<User>
- Defined in client.ts:331

getUserByName

getUserByName(__namedParameters): Promise<User>
Parameters
- __namedParameters: {
  username: string;
  }
  - username: string
Returns Promise<User>
- Defined in client.ts:339

`Private` parseRateLimitHeaders

parseRateLimitHeaders(response, route): void
Parameters
- response: Response
- route: ValidRoutes
Returns void
- Defined in client.ts:157

`Private` processRateLimits

processRateLimits(route, id): Promise<void>
Parameters
- route: ValidRoutes
- id: string
Returns Promise<void>
- Defined in client.ts:134

resetPassword

resetPassword(resetPassword): Promise<void>
Parameters
- resetPassword: ResetPassword
Returns Promise<void>
- Defined in client.ts:347

`Private` setUp

setUp(): Promise<InstanceInfo>
Returns Promise<InstanceInfo>
- Defined in client.ts:117

updateProfile

updateProfile(updateUserProfile): Promise<User>
Parameters
- updateUserProfile: UpdateUserProfile
Returns Promise<User>
- Defined in client.ts:354

updateUser

updateUser(updateUser): Promise<User>
Parameters
- updateUser: UpdateUser
  
  The user to update.
Returns Promise<User>

Link
eludris-api-types.UpdateUser
- Defined in client.ts:370

uploadAttachment

uploadAttachment(__namedParameters): Promise<FileData>
Parameters
- __namedParameters: FileUpload
Returns Promise<FileData>
- Defined in client.ts:229

uploadFile

uploadFile(__namedParameters): Promise<FileData>
Parameters
- __namedParameters: {
  bucket: string;
  } & FileUpload
Returns Promise<FileData>
- Defined in client.ts:210

verifyUser

verifyUser(code): Promise<void>
Verify your email address.
Parameters
- code: {
  code: number;
  }
  
  The code to verify.
  - code: number
Returns Promise<void>
- Defined in client.ts:387