Class: default

client/apis/AccountInformationAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• addStarCodeAffiliate
• deletePhone
• getConsecutiveXboxLoginDays
• getMetaData
• getSelfPromotionChannels
• getStarCodeAffiliate
• getUserBirthdate
• getUserDescription
• getUserGender
• getUserPromotionChannels
• getVerifiedPhoneNumber
• removeStarCodeAffiliate
• request
• resendPhoneCode
• setPhoneNumber
• updateUserBirthdate
• updateUserDescription
• updateUserGender
• updateUserPromotionChannels
• verifyPhone

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/AccountInformationAPI.ts:71

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

addStarCodeAffiliate

▸ addStarCodeAffiliate(options: AddStarCodeAffiliateOptions): Promise<GetStarCodeAffiliate>

Parameters:

Name	Type
options	AddStarCodeAffiliateOptions

Returns: Promise<GetStarCodeAffiliate>

Defined in: client/apis/AccountInformationAPI.ts:294

---

deletePhone

▸ deletePhone(options: SetPhoneNumberOptions): Promise<unknown>

Parameters:

Name	Type
options	SetPhoneNumberOptions

Returns: Promise<unknown>

Defined in: client/apis/AccountInformationAPI.ts:197

---

getConsecutiveXboxLoginDays

▸ getConsecutiveXboxLoginDays(): Promise<GetConsecutiveXboxLoginDays>

Returns: Promise<GetConsecutiveXboxLoginDays>

Defined in: client/apis/AccountInformationAPI.ts:151

---

getMetaData

▸ getMetaData(): Promise<GetMetaData>

Returns: Promise<GetMetaData>

Defined in: client/apis/AccountInformationAPI.ts:162

---

getSelfPromotionChannels

▸ getSelfPromotionChannels(): Promise<UpdateUserPromotionChannelsOptions>

Returns: Promise<UpdateUserPromotionChannelsOptions>

Defined in: client/apis/AccountInformationAPI.ts:236

---

getStarCodeAffiliate

▸ getStarCodeAffiliate(): Promise<GetStarCodeAffiliate>

Returns: Promise<GetStarCodeAffiliate>

Defined in: client/apis/AccountInformationAPI.ts:283

---

getUserBirthdate

▸ getUserBirthdate(): Promise<GetUserBirthdate>

Returns: Promise<GetUserBirthdate>

Defined in: client/apis/AccountInformationAPI.ts:79

---

getUserDescription

▸ getUserDescription(): Promise<GetUserDescription>

Returns: Promise<GetUserDescription>

Defined in: client/apis/AccountInformationAPI.ts:103

---

getUserGender

▸ getUserGender(): Promise<GetUserGender>

Returns: Promise<GetUserGender>

Defined in: client/apis/AccountInformationAPI.ts:127

---

getUserPromotionChannels

▸ getUserPromotionChannels(options: GetUserPromotionChannelsOptions): Promise<Pick<UpdateUserPromotionChannelsOptions, facebook | twitter | youtube | twitch>>

Parameters:

Name	Type
options	GetUserPromotionChannelsOptions

Returns: Promise<Pick<UpdateUserPromotionChannelsOptions, facebook | twitter | youtube | twitch>>

Defined in: client/apis/AccountInformationAPI.ts:247

---

getVerifiedPhoneNumber

▸ getVerifiedPhoneNumber(): Promise<SetPhoneNumberOptions>

Returns: Promise<SetPhoneNumberOptions>

Defined in: client/apis/AccountInformationAPI.ts:173

---

removeStarCodeAffiliate

▸ removeStarCodeAffiliate(): Promise<unknown>

Returns: Promise<unknown>

Defined in: client/apis/AccountInformationAPI.ts:271

---

request

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

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

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

---

resendPhoneCode

▸ resendPhoneCode(options: SetPhoneNumberOptions): Promise<unknown>

Parameters:

Name	Type
options	SetPhoneNumberOptions

Returns: Promise<unknown>

Defined in: client/apis/AccountInformationAPI.ts:210

---

setPhoneNumber

▸ setPhoneNumber(options: SetPhoneNumberOptions): Promise<unknown>

Parameters:

Name	Type
options	SetPhoneNumberOptions

Returns: Promise<unknown>

Defined in: client/apis/AccountInformationAPI.ts:184

---

updateUserBirthdate

▸ updateUserBirthdate(options: GetUserBirthdate): Promise<boolean>

Parameters:

Name	Type
options	GetUserBirthdate

Returns: Promise<boolean>

Defined in: client/apis/AccountInformationAPI.ts:90

---

updateUserDescription

▸ updateUserDescription(options: UpdateUserDescriptionOptions): Promise<boolean>

Parameters:

Name	Type
options	UpdateUserDescriptionOptions

Returns: Promise<boolean>

Defined in: client/apis/AccountInformationAPI.ts:114

---

updateUserGender

▸ updateUserGender(options: UpdateUserGenderOptions): Promise<unknown>

Parameters:

Name	Type
options	UpdateUserGenderOptions

Returns: Promise<unknown>

Defined in: client/apis/AccountInformationAPI.ts:138

---

updateUserPromotionChannels

▸ updateUserPromotionChannels(options: UpdateUserPromotionChannelsOptions): Promise<unknown>

Parameters:

Name	Type
options	UpdateUserPromotionChannelsOptions

Returns: Promise<unknown>

Defined in: client/apis/AccountInformationAPI.ts:258

---

verifyPhone

▸ verifyPhone(options: SetPhoneNumberOptions): Promise<unknown>

Parameters:

Name	Type
options	SetPhoneNumberOptions

Returns: Promise<unknown>

Defined in: client/apis/AccountInformationAPI.ts:223