projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
39 lines (38 loc) • 1.46 kB
TypeScript
/**
* 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
*/
import { ProjectManagerClient } from "../index.js";
import { AstroResult } from "../index.js";
import { WorkSpaceUserInfoDto } from "../index.js";
export declare class MeClient {
private readonly client;
/**
* Internal constructor for this client library
*/
constructor(client: ProjectManagerClient);
/**
* 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(): Promise<AstroResult<WorkSpaceUserInfoDto>>;
/**
* Updates the logged in user avatar
*
* @param fileName The full path of a file to upload to the API
*/
updateMyAvatar(fileName: string): Promise<AstroResult<object>>;
}