services.members.md

services.members

This module provides a service for searching for Topcoder members via API V3.

• services.members
  • static
    • .getService(tokenV3) ⇒ MembersService
  • inner
    • ~MembersService
      • new MembersService(tokenV3)
      • .getMemberFinances(handle) ⇒ Promise
      • .getMemberInfo(handle) ⇒ Promise
      • .getExternalAccounts(handle) ⇒ Promise
      • .getExternalLinks(handle) ⇒ Promise
      • .getSkills(handle) ⇒ Promise
      • .getStats(handle) ⇒ Promise
      • .getStatsHistory(handle) ⇒ Promise
      • .getStatsDistribution(handle, track, subTrack) ⇒ Promise
      • .getMemberSuggestions(keyword) ⇒ Promise
      • .addWebLink(userHandle, webLink) ⇒ Promise
      • .deleteWebLink(userHandle, webLinkHandle) ⇒ Promise
      • .addSkill(handle, skillTagId) ⇒ Promise
      • .hideSkill(handle, skillTagId) ⇒ Promise
      • .updateMemberProfile(profile) ⇒ Promise
      • .updateMemberPhoto(userHandle, file) ⇒ Promise
      • .verifyMemberNewEmail(handle, emailVerifyToken) ⇒ Promise

services.members.getService(tokenV3) ⇒ MembersService

Returns a new or existing members service.

Kind: static method of services.members Returns: MembersService - Members service object

Param	Type	Description
tokenV3	String	Optional. Auth token for Topcoder API v3.

services.members~MembersService

Service class.

Kind: inner class of services.members

• ~MembersService
  • new MembersService(tokenV3)
  • .getMemberFinances(handle) ⇒ Promise
  • .getMemberInfo(handle) ⇒ Promise
  • .getExternalAccounts(handle) ⇒ Promise
  • .getExternalLinks(handle) ⇒ Promise
  • .getSkills(handle) ⇒ Promise
  • .getStats(handle) ⇒ Promise
  • .getStatsHistory(handle) ⇒ Promise
  • .getStatsDistribution(handle, track, subTrack) ⇒ Promise
  • .getMemberSuggestions(keyword) ⇒ Promise
  • .addWebLink(userHandle, webLink) ⇒ Promise
  • .deleteWebLink(userHandle, webLinkHandle) ⇒ Promise
  • .addSkill(handle, skillTagId) ⇒ Promise
  • .hideSkill(handle, skillTagId) ⇒ Promise
  • .updateMemberProfile(profile) ⇒ Promise
  • .updateMemberPhoto(userHandle, file) ⇒ Promise
  • .verifyMemberNewEmail(handle, emailVerifyToken) ⇒ Promise

new MembersService(tokenV3)

Param	Type	Description
tokenV3	String	Optional. Auth token for Topcoder API v3.

membersService.getMemberFinances(handle) ⇒ Promise

Gets member's financial information.

Kind: instance method of MembersService Returns: Promise - Resolves to the financial information object.

Param	Type	Description
handle	String	User handle.

membersService.getMemberInfo(handle) ⇒ Promise

Gets public information on a member.

This method does not require any authorization.

Kind: instance method of MembersService Returns: Promise - Resolves to the data object.

Param	Type	Description
handle	String	Member handle.

membersService.getExternalAccounts(handle) ⇒ Promise

Gets member external account info.

Kind: instance method of MembersService Returns: Promise - Resolves to the stats object.

Param	Type
handle	String

membersService.getExternalLinks(handle) ⇒ Promise

Gets member external links.

Kind: instance method of MembersService Returns: Promise - Resolves to the stats object.

Param	Type
handle	String

membersService.getSkills(handle) ⇒ Promise

Gets member skills.

Kind: instance method of MembersService Returns: Promise - Resolves to the stats object.

Param	Type
handle	String

membersService.getStats(handle) ⇒ Promise

Gets member statistics.

Kind: instance method of MembersService Returns: Promise - Resolves to the stats object.

Param	Type
handle	String

membersService.getStatsHistory(handle) ⇒ Promise

Gets member statistics history

Kind: instance method of MembersService Returns: Promise - Resolves to the stats object.

Param	Type
handle	String

membersService.getStatsDistribution(handle, track, subTrack) ⇒ Promise

Gets member statistics distribution

Kind: instance method of MembersService Returns: Promise - Resolves to the stats object.

Param	Type
handle	String
track	String
subTrack	String

membersService.getMemberSuggestions(keyword) ⇒ Promise

Gets a list of suggested member names for the supplied partial.

WARNING: This method requires v3 authorization.

Kind: instance method of MembersService Returns: Promise - Resolves to the api response content

Param	Type	Description
keyword	String	Partial string to find suggestions for

membersService.addWebLink(userHandle, webLink) ⇒ Promise

Adds external web link for member.

Kind: instance method of MembersService Returns: Promise - Resolves to the api response content

Param	Type	Description
userHandle	String	The user handle
webLink	String	The external web link

membersService.deleteWebLink(userHandle, webLinkHandle) ⇒ Promise

Deletes external web link for member.

Kind: instance method of MembersService Returns: Promise - Resolves to the api response content

Param	Type	Description
userHandle	String	The user handle
webLinkHandle	String	The external web link handle

membersService.addSkill(handle, skillTagId) ⇒ Promise

Adds user skill.

Kind: instance method of MembersService Returns: Promise - Resolves to operation result

Param	Type	Description
handle	String	Topcoder user handle
skillTagId	Number	Skill tag id

membersService.hideSkill(handle, skillTagId) ⇒ Promise

Hides user skill.

Kind: instance method of MembersService Returns: Promise - Resolves to operation result

Param	Type	Description
handle	String	Topcoder user handle
skillTagId	Number	Skill tag id

membersService.updateMemberProfile(profile) ⇒ Promise

Updates member profile.

Kind: instance method of MembersService Returns: Promise - Resolves to the api response content

Param	Type	Description
profile	Object	The profile to update.

membersService.updateMemberPhoto(userHandle, file) ⇒ Promise

Uploads and updates member photo.

Kind: instance method of MembersService Returns: Promise - Resolves to the api response content

Param	Type	Description
userHandle	String	The user handle
file	File	The file to be uploaded

membersService.verifyMemberNewEmail(handle, emailVerifyToken) ⇒ Promise

Verify member new email.

Kind: instance method of MembersService Returns: Promise - Resolves to the api response content

Param	Type	Description
handle	String	The member handle
emailVerifyToken	String	The verify token of new email