Module: client/apis/BadgesAPI
Table of contents
Classes
Type aliases
- DeleteBadgeFromSelf
- DeleteBadgeFromSelfOptions
- DeleteBadgeFromUser
- DeleteBadgeFromUserOptions
- GetBadge
- GetBadgeOptions
- GetUniverseBadges
- GetUniverseBadgesOptions
- GetUserBadges
- GetUserBadgesAwardedDates
- GetUserBadgesAwardedDatesOptions
- GetUserBadgesOptions
- UpdateBadge
- UpdateBadgeOptions
Type aliases
DeleteBadgeFromSelf
Ƭ DeleteBadgeFromSelf: DeleteBadgeFromUser
Defined in: client/apis/BadgesAPI.ts:53
DeleteBadgeFromSelfOptions
Ƭ DeleteBadgeFromSelfOptions: object
Type declaration:
| Name | Type |
|---|---|
badgeId |
number |
Defined in: client/apis/BadgesAPI.ts:50
DeleteBadgeFromUser
Ƭ DeleteBadgeFromUser: unknown
Defined in: client/apis/BadgesAPI.ts:49
DeleteBadgeFromUserOptions
Ƭ DeleteBadgeFromUserOptions: object
Type declaration:
| Name | Type |
|---|---|
badgeId |
number |
userId |
number |
Defined in: client/apis/BadgesAPI.ts:45
GetBadge
Ƭ GetBadge: GameBadgeOptions
Defined in: client/apis/BadgesAPI.ts:9
GetBadgeOptions
Ƭ GetBadgeOptions: object
Type declaration:
| Name | Type |
|---|---|
badgeId |
number |
Defined in: client/apis/BadgesAPI.ts:6
GetUniverseBadges
Ƭ GetUniverseBadges: object
Type declaration:
| Name | Type |
|---|---|
data |
GetBadge[] |
nextPageCursor |
string |
previousPageCursor |
string |
Defined in: client/apis/BadgesAPI.ts:23
GetUniverseBadgesOptions
Ƭ GetUniverseBadgesOptions: object
Type declaration:
| Name | Type |
|---|---|
cursor? |
string |
limit? |
10 | 25 | 50 | 100 |
sortOrder? |
Asc | Desc |
universeId |
number |
Defined in: client/apis/BadgesAPI.ts:17
GetUserBadges
Ƭ GetUserBadges: GetUniverseBadges
Defined in: client/apis/BadgesAPI.ts:34
GetUserBadgesAwardedDates
Ƭ GetUserBadgesAwardedDates: object
Type declaration:
| Name | Type |
|---|---|
data |
{ awardedDate: string ; badgeId: number }[] |
Defined in: client/apis/BadgesAPI.ts:39
GetUserBadgesAwardedDatesOptions
Ƭ GetUserBadgesAwardedDatesOptions: object
Type declaration:
| Name | Type |
|---|---|
badgeIds |
number[] |
userId |
number |
Defined in: client/apis/BadgesAPI.ts:35
GetUserBadgesOptions
Ƭ GetUserBadgesOptions: object
Type declaration:
| Name | Type |
|---|---|
cursor? |
string |
limit? |
10 | 25 | 50 | 100 |
sortOrder? |
Asc | Desc |
userId |
number |
Defined in: client/apis/BadgesAPI.ts:28
UpdateBadge
Ƭ UpdateBadge: unknown
Defined in: client/apis/BadgesAPI.ts:16
UpdateBadgeOptions
Ƭ UpdateBadgeOptions: object
Type declaration:
| Name | Type |
|---|---|
description |
string |
enabled |
boolean |
id |
number |
name |
string |
Defined in: client/apis/BadgesAPI.ts:10