Class Badges

Index

Constructors

Methods

list get getForObservation markAllAsSeen getLastSeen markAsSeen getSeasonLastSeen markSeasonAsSeen

Constructors

constructor

new Badges(client: ObservationClient): Badges
Internal
Parameters
- client: ObservationClient
Returns Badges
- Defined in lib/badges.ts:10

Methods

list

list(): Promise<Paginated<Badge>>
Fetches a list of badges.
- For unauthenticated users, this returns a list of public "onboarding" badges.
- For authenticated users, this returns their personalized list of badges including progress.
Returns Promise<Paginated<Badge>>
A promise that resolves to a paginated list of badge objects.

Throws
If the request fails.
- Defined in lib/badges.ts:22

get

get(id: number): Promise<Badge>
Fetches the details of a specific badge by its ID.
- For unauthenticated users, this returns the public details of the badge.
- For authenticated users, this returns personalized details including their progress.
Parameters
- id: number
  The unique identifier for the badge.
Returns Promise<Badge>
A promise that resolves to the badge object.

Throws
If the request fails.
- Defined in lib/badges.ts:41

getForObservation

getForObservation(observationId: number): Promise<Paginated<{ id: number }>>
Gets all badge IDs that a specific observation contributes to.
Parameters
- observationId: number
  The unique identifier for the observation.
Returns Promise<Paginated<{ id: number }>>
A promise that resolves to a paginated list of badge IDs.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/badges.ts:60

markAllAsSeen

markAllAsSeen(): Promise<{ last_seen: string }>
Marks all regular badges as "seen" for the current user. This updates the last_seen timestamp for all of the user's regular badges.

Returns Promise<{ last_seen: string }>
A promise that resolves to an object with the last_seen timestamp.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/badges.ts:76

getLastSeen

getLastSeen(userBadgeId: number): Promise<{ last_seen: string }>
Gets the last_seen timestamp for a specific regular user badge.
Parameters
- userBadgeId: number
  The unique identifier for the user badge.
Returns Promise<{ last_seen: string }>
A promise that resolves to an object with the last_seen timestamp.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/badges.ts:91

markAsSeen

markAsSeen(userBadgeId: number): Promise<{ last_seen: string }>
Marks a specific regular user badge as "seen".
Parameters
- userBadgeId: number
  The unique identifier for the user badge.
Returns Promise<{ last_seen: string }>
A promise that resolves to an object with the updated last_seen timestamp.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/badges.ts:107

getSeasonLastSeen

getSeasonLastSeen(userSeasonBadgeId: number): Promise<{ last_seen: string }>
Gets the last_seen timestamp for a specific user season badge.
Parameters
- userSeasonBadgeId: number
  The unique identifier for the user season badge.
Returns Promise<{ last_seen: string }>
A promise that resolves to an object with the last_seen timestamp.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/badges.ts:122

markSeasonAsSeen

markSeasonAsSeen(userSeasonBadgeId: number): Promise<{ last_seen: string }>
Marks a specific user season badge as "seen".
Parameters
- userSeasonBadgeId: number
  The unique identifier for the user season badge.
Returns Promise<{ last_seen: string }>
A promise that resolves to an object with the updated last_seen timestamp.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/badges.ts:138