projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
52 lines • 1.72 kB
JavaScript
/**
* ProjectManager API for TypeScript
*
* (c) ProjectManager.com, Inc.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @author ProjectManager.com <support@projectmanager.com>
* @copyright ProjectManager.com, Inc.
* @link https://github.com/projectmgr/projectmanager-sdk-typescript
*/
export class MeClient {
client;
/**
* Internal constructor for this client library
*/
constructor(client) {
this.client = client;
}
/**
* Retrieve information about the currently logged on user.
*
* This API call will always succeed with a 200 OK if called with valid authentication information.
* If the authentication information provided is not valid, calling this API will return a 401
* Authentication Failed error message. If successful, this API returns information about the user
* including its home URL, email address, user name, and workspace name.
*
*/
retrieveMe() {
const url = `/api/data/me`;
return this.client.request("get", url, null, null);
}
/**
* Removes the logged in user's custom avatar so the default initials are shown.
*
*/
removeMyAvatar() {
const url = `/api/data/me/avatar`;
return this.client.request("delete", url, null, null);
}
/**
* Updates the logged in user avatar
*
* @param fileName The full path of a file to upload to the API
*/
updateMyAvatar(fileName) {
const url = `/api/data/me/avatar`;
return this.client.fileUpload("post", url, null, fileName);
}
}
//# sourceMappingURL=MeClient.js.map