Class: default

client/apis/BadgesAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• deleteBadgeFromSelf
• deleteBadgeFromUser
• getBadge
• getUniverseBadges
• getUserBadges
• getUserBadgesAwardedDates
• request
• updateBadge

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/BadgesAPI.ts:55

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

---

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

deleteBadgeFromSelf

▸ deleteBadgeFromSelf(options: DeleteBadgeFromSelfOptions): Promise<unknown>

Parameters:

Name	Type
options	DeleteBadgeFromSelfOptions

Returns: Promise<unknown>

Defined in: client/apis/BadgesAPI.ts:136

---

deleteBadgeFromUser

▸ deleteBadgeFromUser(options: DeleteBadgeFromUserOptions): Promise<unknown>

Parameters:

Name	Type
options	DeleteBadgeFromUserOptions

Returns: Promise<unknown>

Defined in: client/apis/BadgesAPI.ts:124

---

getBadge

▸ getBadge(options: GetBadgeOptions): Promise<GameBadgeOptions>

Parameters:

Name	Type
options	GetBadgeOptions

Returns: Promise<GameBadgeOptions>

Defined in: client/apis/BadgesAPI.ts:63

---

getUniverseBadges

▸ getUniverseBadges(options: GetUniverseBadgesOptions): Promise<GetUniverseBadges>

Parameters:

Name	Type
options	GetUniverseBadgesOptions

Returns: Promise<GetUniverseBadges>

Defined in: client/apis/BadgesAPI.ts:86

---

getUserBadges

▸ getUserBadges(options: GetUserBadgesOptions): Promise<GetUniverseBadges>

Parameters:

Name	Type
options	GetUserBadgesOptions

Returns: Promise<GetUniverseBadges>

Defined in: client/apis/BadgesAPI.ts:98

---

getUserBadgesAwardedDates

▸ getUserBadgesAwardedDates(options: GetUserBadgesAwardedDatesOptions): Promise<GetUserBadgesAwardedDates>

Parameters:

Name	Type
options	GetUserBadgesAwardedDatesOptions

Returns: Promise<GetUserBadgesAwardedDates>

Defined in: client/apis/BadgesAPI.ts:110

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

updateBadge

▸ updateBadge(options: UpdateBadgeOptions): Promise<unknown>

Parameters:

Name	Type
options	UpdateBadgeOptions

Returns: Promise<unknown>

Defined in: client/apis/BadgesAPI.ts:74