projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
61 lines (60 loc) • 3.04 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 { ProjectChangeStatusDto } from "../index.js";
export declare class ChangesetClient {
private readonly client;
/**
* Internal constructor for this client library
*/
constructor(client: ProjectManagerClient);
/**
* Retrieve a Changeset by its unique ID.
*
* A Changeset is an individual edit that has been made to a project. Since multiple users can
* edit a project at the same time, individual Changesets are applied in a sequential fashion. If
* a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a
* Changeset to determine its conflict resolution status.
*
* When checking the status of a Changeset, you can call either RetrieveChangeset or
* RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the
* Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has
* finished processing.
*
* @param changeSetId The unique ID number of the Changeset to retrieve
*/
retrieveChangesetstatus(changeSetId: string): Promise<AstroResult<ProjectChangeStatusDto>>;
/**
* Retrieve a Changeset by its unique ID. This endpoint waits for the Changeset to complete its
* processing prior to returning a result.
*
* A Changeset is an individual edit that has been made to a project. Since multiple users can
* edit a project at the same time, individual Changesets are applied in a sequential fashion. If
* a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a
* Changeset to determine its conflict resolution status.
*
* When checking the status of a Changeset, you can call either RetrieveChangeset or
* RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the
* Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has
* finished processing.
*
* Although most Changesets complete instantly, some Changesets may need additional time to
* complete. If the Changeset cannot be processed within a reasonable length of time, this API
* call may fail. If this API fails, it will return a status error indicating the Changeset is
* still being processed.
*
* @param changeSetId The unique ID number of the Changeset to retrieve
*/
retrieveCompletedChangesetstatus(changeSetId: string): Promise<AstroResult<ProjectChangeStatusDto>>;
}